| GL Studio C++ Runtime API

Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
GlsDynamicPath Class Reference

`#include <gls_dynamic_path.h>`

Inheritance diagram for GlsDynamicPath:

## Classes
class | State

## Public Types
typedef DisplayObject | _BaseClass
| Deprecated typedef for the base class.
typedef DisplayObject | BaseClass
| Typedef for the base class.
typedef DynamicArray< State > | StateArrayType
| Typedef for a list of States.
Public Types inherited from DisplayObject
enum | AvailableAttributesEnum { GLS_ATTRIBUTES_BASIC = 1 , GLS_ATTRIBUTES_DYNAMIC = 2 , GLS_ATTRIBUTES_APPEARANCE = 4 , GLS_ATTRIBUTES_GEOMETRY = 8 , GLS_ATTRIBUTES_SPECIALIZED = 16 , GLS_ATTRIBUTES_ALL = ~0 , GLS_ATTRIBUTES_NONE = 0 }

## Public Member Functions
| GlsDynamicPath (bool generateInstanceName=false)
| GlsDynamicPath (const GlsDynamicPath &that, const bool generateNames)
virtual | ~GlsDynamicPath ()
virtual void | SetAvailableAttributes (unsigned int value) DISTI_METHOD_OVERRIDE
virtual DisplayObject * | CloneObject (bool generateNames=false) DISTI_METHOD_OVERRIDE
virtual void | CopyProperties (DisplayObject *src) DISTI_METHOD_OVERRIDE
virtual void | PreDraw (const OpenGLMatrices &parentMatrices, Culler &culler) DISTI_METHOD_OVERRIDE
virtual void | Draw () DISTI_METHOD_OVERRIDE
virtual DisplayObject * | handle (DisplayEvent *ev) DISTI_METHOD_OVERRIDE
virtual bool | Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint) DISTI_METHOD_OVERRIDE
virtual void | SetValue (int spec, va_list &args) DISTI_METHOD_OVERRIDE
virtual DistiAttributeBase & | Resource (const char *name) DISTI_METHOD_OVERRIDE
virtual void | GetResources (std::ostream &outstr, GlsResourceFilter *filter) DISTI_METHOD_OVERRIDE
void | AffectsLocationX (const bool &value)
bool | AffectsLocationX () const
void | AffectsLocationY (const bool &value)
bool | AffectsLocationY () const
void | AffectsLocationZ (const bool &value)
bool | AffectsLocationZ () const
void | AffectsRotationX (const bool &value)
bool | AffectsRotationX () const
void | AffectsRotationY (const bool &value)
bool | AffectsRotationY () const
void | AffectsRotationZ (const bool &value)
bool | AffectsRotationZ () const
void | AffectsScaleX (const bool &value)
bool | AffectsScaleX () const
void | AffectsScaleY (const bool &value)
bool | AffectsScaleY () const
void | AffectsScaleZ (const bool &value)
bool | AffectsScaleZ () const
void | UseShortRotationPaths (const bool &value)
bool | UseShortRotationPaths () const
StateArrayType & | StateArray ()
const StateArrayType & | StateArray () const
void | FindFirstPathSegmentContainingValue (float value, int *index1, int *index2)
float | FirstStateValue ()
float | LastStateValue ()
Vector | GetPathLocation (float value)
Vector | GetPathRotation (float value)
Vector | GetPathScale (float value)
void | MoveObject (DisplayObject *obj, float value)
void | MoveObjectToState (DisplayObject *obj, int stateNumber)
Public Member Functions inherited from DisplayObject
| DisplayObject (float x, float y, float z)
| DisplayObject (const DisplayObject &object, const bool generateNames)
virtual | ~DisplayObject ()
void | Destroy ()
virtual void | SetAvailableAttributes (unsigned int value)
virtual void | AlphaMode (int mode)
virtual int | AlphaMode ()
virtual bool | AntiAlias ()
virtual void | AntiAlias (bool alias)
void | ApplyTextureSettings (int textureIndex=-1)
DistiAttribDict & | Attributes ()
const DistiAttribDict & | Attributes () const
virtual void | SetBlendColor (const GlsColor &color)
void | GetBlendColor (unsigned char color[])
void | GetBlendColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
virtual GlsColor | GetBlendColor ()
void | SetBlendColor (unsigned char color[])
void | SetBlendColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
virtual bool | BlinkedOff ()
virtual bool | Blinking ()
virtual void | Blinking (const bool blink)
virtual float | BlinkRate ()
virtual void | BlinkRate (const float rate)
const Vector & | BoundingVolumeCenter () const
void | BoundingVolumeCenter (const Vector &center)
bool | BoundingVolumeHit (const Vector &start, const Vector &direction)
float | BoundingVolumeRadius () const
void | BoundingVolumeRadius (float radius)
virtual void | Calculate (double time)
void | CalculateCollisionPoint (const Vector &pickLoc, const Vector &directionVector, Vector *collisionPoint)
virtual void | CalculateParentBoundingBox ()
virtual void | CalculateTextureCoordinates ()
bool | GetTexturePointTransformationMatrix (GlsMatrixType &world2tex)
CallbackMethodCallerBase * | CallbackCaller () const
void | CallbackCaller (CallbackMethodCallerBase *cb)
virtual void | GetCenter (Vector &center)
virtual DisplayObject * | CloneObject (bool generateNames=false)=0
virtual GlsColor | GetColor ()
void | GetColor (unsigned char c4[])
void | GetColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
virtual void | SetColor (const GlsColor &color)
void | SetColor (unsigned char c4[])
void | SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
virtual void | CopyGeometry (DisplayObject *src)
virtual void | CopyHierarchyProperties (DisplayObject *src, bool copyName)
virtual void | CopyProperties (DisplayObject *src)
virtual void | CullBackFace (const bool val)
virtual bool | CullBackFace ()
bool | Culled () const
void | Culled (bool val)
bool | CullTest (const GlsMatrixType *matrix, const Culler &culler)
GlsMatrixType & | DcsMatrix ()
GlsMatrixType | DcsMatrix () const
void | DcsMatrix (const GlsMatrixType &matrix)
virtual void | DeleteVertexAt (unsigned int index)
virtual void | DeleteVertex (unsigned int indexAfter) final
virtual int | DepthTest ()
virtual void | DepthTest (unsigned char zbuf)
virtual void | Draw ()=0
const GlsMatrixType * | DrawMatrix ()
bool | NeedCalcDrawMatrix ()
void | DynamicRotate (float angle, int axis)
void | DynamicRotate (const Vector &v)
void | DynamicRotate (float angle[])
virtual void | DynamicRotate (float x, float y, float z)
virtual void | DynamicRotateRelative (float angle, int axis)
virtual float | DynamicRotation (int axis)
virtual Vector | DynamicRotation ()
virtual Vector | DynamicScale ()
virtual void | DynamicScale (float x, float y, float z)
void | DynamicScale (const Vector &scale)
virtual void | DynamicTranslate (float x, float y, float z, bool relative=false)
void | DynamicTranslate (const Vertex &amount, bool relative)
void | DynamicTranslate (const Vector &amount)
virtual void | DynamicTranslateAxis (float amount, int axis, bool relative)
virtual float | DynamicTranslation (int axis)
virtual Vector | DynamicTranslation ()
DisplayObjectEditor * | Editor ()
const DisplayObjectEditor * | Editor () const
void | Editor (DisplayObjectEditor *editor)
virtual void | GetExtents (float &x, float &y, float &z, float &x1, float &y1, float &z1)
void | GetExtentsDCS (Vector &min, Vector &max)
void | GetFillColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
void | GetFillColor (unsigned char c4[])
virtual GlsColor | GetFillColor ()
void | SetFillColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
void | SetFillColor (unsigned char c4[])
virtual void | SetFillColor (const GlsColor &color)
virtual void | FinishObject ()
virtual void | GenerateInstanceName ()
virtual DisplayObject * | handle (DisplayEvent *ev)
virtual bool | Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint)
virtual bool | HitUtil (float x, float y, float z, float scale, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector, Vector *collisionPoint)
virtual void | InsertVertexAt (unsigned int index)
virtual void | InsertVertex (unsigned int indexAfter) final
char * | InstanceName ()
const char * | InstanceName () const
void | InstanceName (const char *name)
virtual bool | LightingEnabled ()
virtual void | LightingEnabled (bool lighting)
virtual int | LineStippleMultiplier ()
virtual void | LineStippleMultiplier (int mult)
virtual int | LineStipplePattern ()
virtual void | LineStipplePattern (int pattern)
virtual float | LineWidth ()
virtual void | LineWidth (float width)
virtual const Vertex & | Location () const
virtual void | Location (const Vertex &v)
virtual void | Location (float x, float y, float z)
virtual void | GetLocation (Vertex &v)
virtual void | GetLocation (float &x, float &y, float &z)
float | X () const
float | Y () const
float | Z () const
void | X (const float x)
void | Y (const float y)
void | Z (const float z)
virtual int | MaterialIndex ()
virtual void | MaterialIndex (int index)
virtual DynamicArray< int > & | MaterialIndices ()
virtual void | MaterialIndices (DynamicArray< int > indices)
GlsMatrixType * | ModelMatrix ()
bool | NeedCalculate ()
Vector * | Normals ()
virtual void | SetNormals (unsigned int nPoints, Vector *vertices)
void | VaSetNormals (unsigned int nPoints,...)
unsigned int | NumberOfVertices () const
virtual float | ObjectDepth ()
virtual float | ObjectHeight ()
virtual float | ObjectWidth ()
virtual void | SetOrigin (const Vertex &vert)
virtual void | Parent (DisplayFrame *par)
DisplayFrame * | Parent () const
virtual void | ParentGroup (Group *group)
Group * | ParentGroup () const
virtual DisplayObject * | Pick3D (const Vector &winLoc, const Vector &logicalCoords, float scale, const Vector &directionVector, Vector &collisionWinLoc, const OpenGLMatrices &drawnMatrices)
unsigned char | Pickable ()
virtual void | Pickable (unsigned char pick)
virtual int | PolygonEnd ()
virtual void | PolygonEnd (const int end)
virtual int | PolygonMode ()
virtual void | PolygonMode (int mode)
virtual void | PreDraw (const OpenGLMatrices &current, Culler &culler)
GlsMatrixType * | ProjMatrix ()
virtual void | ReallocateVertices (unsigned int numVertices, bool initializeNew, bool copyOld)
virtual float | RelativeAngle (const float x, const float y)
virtual DistiAttributeBase & | Resource (const char *name)
virtual void | GetResources (std::ostream &outstr, GlsResourceFilter *filter=NULL)
const Vertex & | RotationPoint () const
virtual void | RotationPoint (const Vertex &v)
virtual void | RotationPoint (float x, float y, float z)
virtual void | GetRotationPoint (Vertex &v)
virtual void | Rotate (float angle, int axis=Z_AXIS)
virtual void | Rotate (const Vector &origin, float angle, int axis=Z_AXIS)
virtual void | Rotate (const Vector &orig, float angle, const Vector &axis)
void | SaveMatrices ()
virtual void | Scale (float px, float py, float pz, Vertex *anchor, int handleBar=0)
void | Set (int spec,...)
bool | SetupAlpha ()
void | SetupDepthTest ()
void | SetupLighting ()
bool | SetupLineStyle ()
bool | SetupTexture ()
virtual int | Shading ()
virtual void | Shading (const int shading)
virtual void | GetTransformedExtents (Vector &min, Vector &max, const GlsMatrixType &matrix, bool resetMinMax=true)
virtual void | SetTexCoords (unsigned int nPoints, Vector *new_tex_coord, bool isVectorArray=true)
void | SetTexCoords (unsigned int nPoints, Vertex *new_tex_coord)
void | VaSetTexCoords (unsigned int nPoints,...)
Vector * | TextureCoordinates ()
Vector * | GetTextureCoordinates ()
virtual int | TextureIndex ()
virtual void | TextureIndex (int textureIndex)
virtual Vector * | GetTexturePoints ()
virtual bool | TextureRepeat ()
virtual void | TextureRepeat (const int rep)
virtual int | TextureMappingTechnique ()
virtual void | TextureMappingTechnique (const int map)
virtual int | TextureMagnificationFilter ()
virtual void | TextureMagnificationFilter (const int filter)
virtual int | TextureMinificationFilter ()
virtual void | TextureMinificationFilter (const int filter)
virtual void | Translate (float tr[])
virtual void | Translate (float x, float y, float z)
virtual void | TranslateVertices (float x, float y, float z)
virtual void | UpdateBoundingVolume ()
void * | UserData () const
void | UserData (void *data)
virtual void | SetVertexColor (unsigned int vertex, unsigned char CurrentFillColor[])
virtual Vertex * | Vertices ()
virtual void | SetVertices (unsigned int nPoints, Vertex *vertices)
void | VaSetVertices (unsigned int nPoints,...)
int * | ViewMatrix ()
bool | Visible () const
bool | Visibility () const
virtual void | Visibility (const bool vis)
virtual Vector | WorldRotationPoint ()
virtual void | WorldRotationPoint (const Vector &vert)
virtual Vertex | WorldVertex (unsigned int i)
virtual void | WorldVertex (unsigned int i, const Vertex &vert)
bool | LogicalToWindow (const Vector &logical, Vector &winLoc, const OpenGLMatrices &alternateMatrices=OpenGLMatrices())
bool | WindowToLogical (const Vector &winLoc, Vector &logical, Vector *directionVector=NULL, const OpenGLMatrices &alternateMatrices=OpenGLMatrices())
void | LogicalToDCS (Vector logicalPoint, Vector &objectLocal, const Vector *directionVector, const Vector &planeNormal=Vector(0, 0, 1), const Vector &planePoint=Vector(), const GlsMatrixType *dcsMatrix=NULL)
void | DCSToLogical (Vector dcsPoint, Vector &logicalPoint, const GlsMatrixType *dcsMatrix=NULL)
bool | Create (GlsGloFile &dataStream, Group *parent)
void | GeometryRefresh ()
| Invalidates the painter and refreshes the geometry on the next paint cycle.
virtual bool | GetPlaneVectorPoints (Vertex &p1, Vertex &p2, Vertex &p3, Vertex &planeVector)
void | NotifyAttributeChanged (const AttributeName &name) override
virtual void | SetPainter (GlsPainter *painter)
virtual GlsPainter * | GetPainter ()
void | InvalidatePainter ()
virtual bool | IsVisibleInScene (const DisplayObject *obj=NULL) const
Public Member Functions inherited from AttributeChangedNotifier
virtual void | NotifyAttributeChanged (const AttributeName &name)=0
virtual | ~AttributeChangedNotifier ()
Public Member Functions inherited from WeakReferenceableMixin
void | AddWeakReference (WeakReference *weakRef) override
void | NotifyWeakReferenceDestroyed (WeakReference *ref) override
virtual void | AddWeakReference (WeakReference *weakRef)=0
virtual void | NotifyWeakReferenceDestroyed (WeakReference *weakReference)=0

## Static Public Member Functions
static DisplayObject * | CreateInstance ()
Static Public Member Functions inherited from DisplayObject
static void | UseManualBlinkElapsedTime (bool useManualTime)
static void | SetManualBlinkElapsedTime (double elapsedTime)

## Protected Member Functions
virtual GLS_EXPORT void | SetFromGloData (GlsGloFileAttribute &data) DISTI_METHOD_OVERRIDE
Protected Member Functions inherited from DisplayObject
virtual void | VaListSetVertices (unsigned int nPoints, va_list args)
virtual void | VaListSetNormals (unsigned int nPoints, va_list args)
virtual void | VaListSetTexCoords (unsigned int nPoints, va_list args)
void | ApplyTextureMinMagSettings ()
| Updates the state manager's texture minification and magnification filter based on this display's configuration.
void | ApplyTextureEnvModeSettings ()
| Updates the state manager's texture environment based on this object configuration.
bool | SetupTextureIsNeeded ()
virtual int | ColorMaterialMode ()
void | AllocateModelMatrix ()
bool | ApplyDynamicRotation ()
virtual void | CalcDrawMatrix ()
void | CalcDrawMatrixIfExists ()
virtual void | CalculateMatrices (const OpenGLMatrices &newMatrices)
bool | InsideVertexExtents (float x, float y, unsigned int nVerts, Vertex *verts, float tolerance)
void | LastDrawMatrixLocation (const Vertex &loc)
const Vertex & | LastDrawMatrixLocation ()
void | NeedCalculate (bool val)
void | PickSetup (float x, float y, float z, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector)
void | PickCleanup (Vertex *vertices, unsigned int vertex_cnt)
virtual void | SetFromGloData (GlsGloFileAttribute &data)
virtual void | SetValue (int spec, va_list &args)
int | GetApplicableTextureIndex ()
int | GetApplicableTextureRepeat ()
Protected Member Functions inherited from WeakReferenceableMixin
| WeakReferenceableMixin ()
virtual | ~WeakReferenceableMixin ()

## Protected Attributes
bool | _affectsLocationX
| If true, this path will affect an object's X location.
bool | _affectsLocationY
| If true, this path will affect an object's Y location.
bool | _affectsLocationZ
| If true, this path will affect an object's Z location.
bool | _affectsRotationX
| If true, this path will affect an object's X rotation.
bool | _affectsRotationY
| If true, this path will affect an object's Y rotation.
bool | _affectsRotationZ
| If true, this path will affect an object's Z rotation.
bool | _affectsScaleX
| If true, this path will affect an object's X scale.
bool | _affectsScaleY
| If true, this path will affect an object's Y scale.
bool | _affectsScaleZ
| If true, this path will affect an object's Z scale.
bool | _useShortRotationPaths
| If true, this state will rotate in the direction that will reach the desired angle the fastest.
StateArrayType | _stateArray
| The list of animation states for this path.
Protected Attributes inherited from DisplayObject
bool | _geometryRefresh
| Whether or not the geometry (VBOs etc.) needs to be updated on the GPU.
int | _alphaMode
bool | _antiAlias
bool | _attributesAdded
bool | _blinking
float | _blinkRate
bool | _isBlinkedOff
| Stores whether the object is presently blinked on or off.
GlsColor | _color
bool | _cullBackFace
GlsMatrixType | _dcsMatrix
unsigned char | _depthTest
GlsMatrixType * | _drawMatrix
bool | _needCalcDrawMatrix
| True if CalcDrawMatrix() needs to be called on this object.
unsigned char | _lineStippleMultiplier
unsigned short | _lineStipplePattern
float | _lineWidth
Vertex | _location
DynamicArray< int > | _materialIndices
| List of materials associated with this object.
GlsMatrixType * | _modelMatrix
Vector * | _normals
unsigned int | _nTex_vertices
unsigned int | _nVertices
unsigned char | _polygonEnd
unsigned char | _polygonMode
GlsMatrixType * | _projMatrix
unsigned char | _shading
Vector * | _texCoord
GlsColor | _textureBlendColor
int | _textureIndex
unsigned char | _textureMagFilter
unsigned char | _textureMinFilter
unsigned char | _textureMap
Vector | _texturePoints [4]
unsigned char | _textureRepeat
void * | _userData
Vertex * | _vertices
int * | _viewMatrix
bool | _visible
IGlsStateManager * | _stateManager
| The state manager that interfaces with OpenGL and maintains its render state.
Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * | _weakRefs

## Friends
class | GlsDynamicPathEditor

## Detailed Description

Runtime implementation of a GlsDynamicPath

## Constructor & Destructor Documentation

## ◆ GlsDynamicPath() [1/2]

GlsDynamicPath | ( | bool | generateInstanceName = `false` | ) |

Create a new GlsDynamicPath.

Parameters

  generateInstanceName | Whether or not to generate an instance name for this inputdevice

## ◆ GlsDynamicPath() [2/2]

GlsDynamicPath | ( | const GlsDynamicPath & | that,
|  | const bool | generateNames
| ) |  |

The copy constructor for GlsDynamicPath

Parameters

  that | The GlsDynamicPath object that is being copied
  generateNames | Whether or not to generate a new instance name

## ◆ ~GlsDynamicPath()

virtual ~GlsDynamicPath | ( |  | ) |
| virtual

Destructs a GlsDynamicPath object

## Member Function Documentation

## ◆ AffectsLocationX() [1/2]

bool AffectsLocationX | ( |  | ) | const
| inline

Returns
  Whether the path will affect the X component of the object's dynamic translation.

## ◆ AffectsLocationX() [2/2]

void AffectsLocationX | ( | const bool & | value | ) |

Set whether the path will affect the X component of the object's dynamic translation.

Parameters

  value | The new component value.

## ◆ AffectsLocationY() [1/2]

bool AffectsLocationY | ( |  | ) | const
| inline

Returns
  Whether the path will affect the Y component of the object's dynamic translation.

## ◆ AffectsLocationY() [2/2]

void AffectsLocationY | ( | const bool & | value | ) |

Set whether the path will affect the Y component of the object's dynamic translation.

Parameters

  value | The new component value.

## ◆ AffectsLocationZ() [1/2]

bool AffectsLocationZ | ( |  | ) | const
| inline

Returns
  Whether the path will affect the Z component of the object's dynamic translation.

## ◆ AffectsLocationZ() [2/2]

void AffectsLocationZ | ( | const bool & | value | ) |

Set whether the path will affect the Z component of the object's dynamic translation.

Parameters

  value | The new component value.

## ◆ AffectsRotationX() [1/2]

bool AffectsRotationX | ( |  | ) | const
| inline

Returns
  Whether the path will affect the X component of the object's dynamic rotation.

## ◆ AffectsRotationX() [2/2]

void AffectsRotationX | ( | const bool & | value | ) |

Set whether the path will affect the X component of the object's dynamic rotation.

Parameters

  value | The new component value.

## ◆ AffectsRotationY() [1/2]

bool AffectsRotationY | ( |  | ) | const
| inline

Returns
  Whether the path will affect the Y component of the object's dynamic rotation.

## ◆ AffectsRotationY() [2/2]

void AffectsRotationY | ( | const bool & | value | ) |

Set whether the path will affect the Y component of the object's dynamic rotation.

Parameters

  value | The new component value.

## ◆ AffectsRotationZ() [1/2]

bool AffectsRotationZ | ( |  | ) | const
| inline

Returns
  Whether the path will affect the Z component of the object's dynamic rotation.

## ◆ AffectsRotationZ() [2/2]

void AffectsRotationZ | ( | const bool & | value | ) |

Set whether the path will affect the Z component of the object's dynamic rotation.

Parameters

  value | The new component value.

## ◆ AffectsScaleX() [1/2]

bool AffectsScaleX | ( |  | ) | const
| inline

Returns
  Whether the path will affect the X component of the object's dynamic scale.

## ◆ AffectsScaleX() [2/2]

void AffectsScaleX | ( | const bool & | value | ) |

Set whether the path will affect the X component of the object's dynamic scale.

Parameters

  value | The new component value.

## ◆ AffectsScaleY() [1/2]

bool AffectsScaleY | ( |  | ) | const
| inline

Returns
  Whether the path will affect the Y component of the object's dynamic scale.

## ◆ AffectsScaleY() [2/2]

void AffectsScaleY | ( | const bool & | value | ) |

Set whether the path will affect the Y component of the object's dynamic scale.

Parameters

  value | The new component value.

## ◆ AffectsScaleZ() [1/2]

bool AffectsScaleZ | ( |  | ) | const
| inline

Returns
  Whether the path will affect the Z component of the object's dynamic scale.

## ◆ AffectsScaleZ() [2/2]

void AffectsScaleZ | ( | const bool & | value | ) |

Set whether the path will affect the Z component of the object's dynamic scale.

Parameters

  value | The new component value.

## ◆ CloneObject()

virtual DisplayObject * CloneObject | ( | bool | generateNames = `false` | ) |
| virtual

Copy+Create operation in one method. In derived classes, this method will create a new instance of the derived class and then copy the object into the new instance. The cut,copy,paste and undo operations use this method.

Parameters

  generateNames | Whether or not to generate new names for cloned objects

Returns
  A new object, identical to the original, except for the instance name

Implements DisplayObject.

## ◆ CopyProperties()

virtual void CopyProperties | ( | DisplayObject * | src | ) |
| virtual

Copies the attributes except for geometry attributes from one object to another. Used by the undo mechanism to undo most attribute change operations.

Parameters

  src | The object to copy properties from

Reimplemented from DisplayObject.

## ◆ CreateInstance()

static DisplayObject * CreateInstance | ( |  | ) |
| static

Returns
  A pointer to a new GlsDynamicPath object.

## ◆ Draw()

virtual void Draw | ( |  | ) |
| virtual

Draws this object on the current display frame (_parent member). Pure virtual method

Implements DisplayObject.

## ◆ FindFirstPathSegmentContainingValue()

void FindFirstPathSegmentContainingValue | ( | float | value,
|  | int * | index1,
|  | int * | index2
| ) |  |

Iterates through the path segments and returns the first one found that contains the given value. Special cases: value is before start of the path: index1 == index2 == 0 value is past the end of the path: index1 == index2 == (StateArray().Count()-1)

Parameters

  value | The value to search for.
  index1 | Returns the index of the state at the start of the segment or -1 if no segments are found.
  index2 | Returns the index of the state at the end the segment or -1 if no segments are found.

## ◆ FirstStateValue()

float FirstStateValue | ( |  | ) |
| inline

Returns
  The Value for the first state or 0 if there are no states.

## ◆ GetPathLocation()

Vector GetPathLocation | ( | float | value | ) |

Returns
  The linearly interpolated location along the path for the given value.

Parameters

  value | The value used to get the path location.

## ◆ GetPathRotation()

Vector GetPathRotation | ( | float | value | ) |

Returns
  The linearly interpolated rotation along the path for the given value.

Parameters

  value | The value used to get the path rotation.

## ◆ GetPathScale()

Vector GetPathScale | ( | float | value | ) |

Returns
  The linearly interpolated scale along the path for the given value.

Parameters

  value | The value used to get the path scale.

## ◆ GetResources()

virtual void GetResources | ( | std::ostream & | outstr,
|  | GlsResourceFilter * | filter
| ) |  |
| virtual

Writes the resources (attributes) of this object to the specified stream. The output of this method can be controlled by the GlsResourceFilter. Note that if filter->NamesOnly() is false (the default), then only resources that can return a value will appear in the list.

See also
  GlsResourceFilter
  DistiAttributeProperty

Parameters

  outstr | The stream to write to
  filter | The filter to determine what to write

Reimplemented from DisplayObject.

## ◆ handle()

virtual DisplayObject * handle | ( | DisplayEvent * | ev | ) |
| virtual

Handles an event that is sent to the object.

Parameters

  ev | The event to send to the object

Returns
  Which object handled the event

Reimplemented from DisplayObject.

## ◆ Hit()

virtual bool Hit | ( | float | x,
|  | float | y,
|  | float | z,
|  | float | scale,
|  | const Vector & | directionVector,
|  | Vector * | collisionPoint
| ) |  |
| virtual

Determines if the object is hit by a pick ray starting at (x,y,z) and pointing towards directionVector in object logical coordinate system. If Pickable() == PICK_BEST it will return the closest point that was hit, otherwise it returns the first point that was hit. This method should not pick points behind the viewer.

Parameters

  x | X coordinate of pick ray start in logical coordinates.
  y | Y coordinate of pick ray start in logical coordinates.
  z | Z coordinate of pick ray start in logical coordinates.
  scale | The scale factor of the window. Affects picking of outlines. Standard value is 1.0.
  directionVector | The direction of the pick ray.
  collisionPoint | If this method returns true, this Vector will contain the location that was hit in logical coordinates.

Returns
  boolean indicating if the object was hit by the pick ray.

Reimplemented from DisplayObject.

## ◆ LastStateValue()

float LastStateValue | ( |  | ) |
| inline

Returns
  The Value for the last state or 0 if there are no states.

## ◆ MoveObject()

void MoveObject | ( | DisplayObject * | obj,
|  | float | value
| ) |  |

Moves a DisplayObject to the position along the path corresponding with the given value.

Parameters

  obj | the DisplayObject to move
  value | The value used to position the object on the path

## ◆ MoveObjectToState()

void MoveObjectToState | ( | DisplayObject * | obj,
|  | int | stateNumber
| ) |  |

Sets the object to the position corresponding with the given state. Which values are applied is controlled by the AffectsLocation* and AffectsRotation* properties.

Parameters

  obj | Pointer to the object to move.
  stateNumber | The index of the state to set the object to. If this value is outside the range [0,StateArray().Count()-1] nothing is done.

## ◆ PreDraw()

virtual void PreDraw | ( | const OpenGLMatrices & | current,
|  | Culler & | culler
| ) |  |
| virtual

Traverses the hierarchy calculating the _modelMatrix, _projMatrix, _viewMatrix as needed.

Parameters

  current | Current matrices inherited from parent
  culler | Object that possibly marks this object for culling

Reimplemented from DisplayObject.

## ◆ Resource()

virtual DistiAttributeBase & Resource | ( | const char * | name | ) |
| virtual

Gets a reference to the specified attribute for reading and writing. This reference can be streamed into and out of variables. For Example: someObject->Resource("Visible") >> someBool; someBool << someObject->Resource("Visible");

Parameters

  name | The name of the attribute to be returned.

Returns
  A reference to the attribute if it is present, or DistiEmptyAttribute if not.

Reimplemented from DisplayObject.

## ◆ SetAvailableAttributes()

virtual void SetAvailableAttributes | ( | unsigned int | value | ) |
| virtual

Specifies which attributes are available for the object. Currently the available attributes cannot be changed after they have been set. (Only the first call has an effect.)

Parameters

  value | A bitfield specifying which types of attributes to make available.

See also
  AvailableAttributesEnum

Reimplemented from DisplayObject.

## ◆ SetFromGloData()

virtual GLS_EXPORT void SetFromGloData | ( | GlsGloFileAttribute & | data | ) |
| protected virtual

Set a single attribute from the GLO file.

Parameters

  data | The attribute to set and its associated data.

Reimplemented from DisplayObject.

## ◆ SetValue()

virtual void SetValue | ( | int | spec,
|  | va_list & | args
| ) |  |
| virtual

Sets an attribute of this object using variable arguments

Parameters

  spec | A GLS_Initializer tag
  args | A variable argument list

Reimplemented from DisplayObject.

## ◆ StateArray() [1/2]

StateArrayType & StateArray | ( |  | ) |
| inline

Returns
  the StateArray associated with this object. Use this array to modify the states that make up the path.

## ◆ StateArray() [2/2]

const StateArrayType & StateArray | ( |  | ) | const
| inline

Returns
  the const StateArray associated with this object.

## ◆ UseShortRotationPaths() [1/2]

bool UseShortRotationPaths | ( |  | ) | const
| inline

Returns
  True if the shortest path between rotations is taken (360 degrees = no net rotation), otherwise false.

## ◆ UseShortRotationPaths() [2/2]

void UseShortRotationPaths | ( | const bool & | value | ) |

If true, the shortest path between rotations is taken (360 degrees = no net rotation). If false, the long path is taken.

Parameters

  value | The new rotation behavior.

The documentation for this class was generated from the following file:

- gls_dynamic_path.h