Class: Prop (of View)

The Prop class is an extension of the View class.

Properties

  • y
  • x
  • z
  • heading
  • yStep
  • view
  • loop
  • cel
  • priority
  • underBits
  • signal
  • nsTop
  • nsLeft
  • nsBottom
  • nsRight
  • lsTop
  • lsLeft
  • lsBottom
  • lsRight
  • brTop
  • brLeft
  • brBottom
  • brRight
  • cycleSpeed
  • script
  • cycler
  • timer

Methods

  • void doit()

    The doit method is generally the action method, which is executed every interpreter cycle.

    If bit 15 of signal is set, it will return, not doing anything. Otherwise, if the script property is not NULL, it will call the doit() method in script.
    Following, it checks to see if bit 2 of signal is set, and bit 1 is not set. If this is TRUE, it returns. Otherwise, if the cycler property is not NULL, it will call the doit() method in cycler.

  • bool handleEvent(heapPtr pEvent)

    If the script property is not NULL, it calls the handleEvent() method of script with pEvent as it's parameter. It then returns whether of not pEvent has been claimed.

  • void delete()

    If bit 15 of signal is set, it disposes of the Prop.

  • void motionCue()

    If cycler is not NULL, and the completed property of cycler is TRUE, it calls the cue() method of cycler.

  • void setCycle(heapPtr theCycler[, sendParams])

    If the cycler property is not NULL, it disposes it. Next, it checks to see if theCycler is NULL. If it is, it sets the cycler property to NULL and returns. Otherwise, it sets the cycler property to theCycler. It then calls the init() method of cycler, and, if specified, the sends the other selectors to the cycler as well.

    Note that is theCycler is an instance, then the it is assigned to the cycler property. If it is a class, a new instance of it is created, and cycler is assigned to the instance's handle.

  • void setScript(heapPtr theScript[, sendParams])

    If the script property is set, it is disposed of. Following, if theScript is not NULL, it's init() method is called. If specified, the sendParams are also sent to it.

  • void cue()

    If the script property is not NULL, the cue() method of it is called.