DART_Events::PositionCue Class Reference

The cue is fired when positions between two things fufill the specificied relationship (entering or leaving the zone). More...

List of all members.

Public Member Functions
	new (me)
	getPropertyDescriptionList (aScript)
	positionCueList ()
	beginSprite (me)
	endSprite (me)
	getComparisonPosition (me)
	getPositionInfo (me)
	positionCueUpdate (me, myPosition)
	SphereComparison (currentDistance, cueName)
Public Attributes
	ActorNames
	Global list of actor names.
	g3Dsprite
	The sprite channel the 3d castmember is on.
	currentPuppetInstance
	A pointer to the puppet instance (see Puppet of Oz).
Private Attributes
	pCueType
	What will trigger this cue?
	pParam1
	Reference location or Actor name or "Camera".
	pParam2
	Zone radius.
	pNumTimes
	Number of times this cue can be fired.
	ancestor
	We inherit the CueName and Wizardable stuff from the Cue-Parent script.

---

Detailed Description

The cue is fired when positions between two things fufill the specificied relationship (entering or leaving the zone).

There are 5 different types of comparisons that can be made: 1) Compare 3D to static position (pParam1 is the static location in xyz) 2) Compare 3D Actor (ie ObjectActor, SketchActor) to static position ((pParam1 is the static location in xyz) 3) Compare 3DCamera to an Actor (pParam1 is the name of the Actor) (PositionCue is placed on 3DCamera) 4) Compare Actor to the 3DCamera (pParam1 is "Camera" - no quotes) (PositionCue is placed on the Actor) 5) Compare Actor to another Actor (pParam1 is name of the second Actor) (PositionCue is placed on the first Actor)

The zone's radius in cm is specifiied in the second parameter and the number of times this can be triggered is specified

PositionCue can be placed on top of the 3DCamera or any 3D Actor.

Copyright 2004, Georgia Tech Research Corporation, Atlanta, Georgia 30332-0415 --All Rights Reserved-- (See LICENSE cast member for full license information)

---

Member Function Documentation

DART_Events::PositionCue::beginSprite (  me   )

DART_Events::PositionCue::endSprite (  me   )

DART_Events::PositionCue::getComparisonPosition (  me   )

DART_Events::PositionCue::getPositionInfo (  me   )

DART_Events::PositionCue::getPropertyDescriptionList (  aScript   )

DART_Events::PositionCue::new (  me   )

DART_Events::PositionCue::positionCueList (   )

DART_Events::PositionCue::positionCueUpdate (  me  , myPosition  )

DART_Events::PositionCue::SphereComparison (  currentDistance  , cueName  )

---

Member Data Documentation

DART_Events::PositionCue::ActorNames

Global list of actor names.

DART_Events::PositionCue::ancestor [private]

We inherit the CueName and Wizardable stuff from the Cue-Parent script.

DART_Events::PositionCue::currentPuppetInstance

A pointer to the puppet instance (see Puppet of Oz).

DART_Events::PositionCue::g3Dsprite

The sprite channel the 3d castmember is on.

DART_Events::PositionCue::pCueType [private]

What will trigger this cue?

DART_Events::PositionCue::pNumTimes [private]

Number of times this cue can be fired.

DART_Events::PositionCue::pParam1 [private]

Reference location or Actor name or "Camera".

DART_Events::PositionCue::pParam2 [private]

Zone radius.

---