GL Studio API
Classes | Public Member Functions | Protected Member Functions | List of all members
Group Class Reference

#include <group.h>

Inheritance diagram for Group:
DisplayObject AttributeChangedNotifier WeakReferenceableMixin WeakReferenceable ComponentBase Gls3DCable GlsClippingGroup GlsKnob GlsLodGroup GlsMimicGroup GlsMultiView GlsMutexGroup GlsOdometer GlsPushButton GlsSortedDrawGroup GlsSwitch GlsThumbWheel Statistics

Classes

class  CompatabilityListItem
 

Public Member Functions

virtual InterfaceListTypeGetCppInterfaceDescription (InterfaceListType *addToThisList=NULL)
 
virtual void GetCppInterfaceDescriptionFree (InterfaceListType *array)
 
DisplayObjectFindByName (const char *name)
 
virtual DisplayObjectFindByNameSameFrame (const char *name)
 
DisplayObjectFindByName (DisplayObject *obj)
 
DisplayObjectFindByQualifiedName (const char *name)
 
DisplayObjectFindNonRecursive (DisplayObject *obj)
 
DisplayObjectArrayObjects (void)
 
DisplayObjectItem (unsigned int index)
 
bool PerformGroupCullCheck (void) const
 
void PerformGroupCullCheck (bool mode)
 
bool CullTestChildren (void) const
 
void CullTestChildren (bool mode)
 
unsigned int Count (void) const
 
DisplayObjectPtr operator[] (unsigned int index)
 
DisplayObjectFirstObject ()
 
DisplayObjectLastObject (void)
 
bool IsEmpty () const
 
int Position (DisplayObject *obj)
 
 Group (int generateInstance=0)
 
 Group (const Group &group, bool generateNames)
 
void InitialGroupCount (unsigned int cnt)
 
virtual ~Group ()
 
virtual void DeleteAllChildren ()
 
virtual void SetAvailableAttributes (unsigned int value)
 
virtual DisplayObjectCloneObject (bool generateNames=false)
 
virtual void CopyGeometry (DisplayObject *src)
 
virtual void CopyProperties (DisplayObject *src)
 
virtual void Draw (void)
 
virtual void PreDraw (const OpenGLMatrices &current, Culler &culler)
 
virtual bool Hit (float x, float y, float z, float scale, const Vector &directionVector, Vector *collisionPoint)
 
virtual DisplayObjectPick3D (const Vector &winLoc, const Vector &logicalCoords, float scale, const Vector &directionVector, Vector &collisionWinLoc, const OpenGLMatrices &drawnMatrices)
 
virtual void Parent (DisplayFrame *par)
 
virtual void Location (const Vertex &v)
 
virtual void Location (float x, float y, float z)
 
virtual void Translate (float x, float y, float z)
 
virtual void Translate (float transAmount[])
 
virtual void TranslateVertices (float x, float y, float z)
 
virtual void GetExtents (float &x, float &y, float &z, float &x1, float &y1, float &z1)
 
virtual void GetTransformedExtents (Vector &min, Vector &max, const GlsMatrixType &matrix, bool resetMinMax=true)
 
virtual void Rotate (const Vector &orig, float angle, const Vector &axis)
 
virtual void Scale (float scale_x, float scale_y, float scale_z, Vertex *anchor=NULL, int handle=0)
 
virtual void InsertObject (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=-1)
 
virtual bool DeleteObject (DisplayObject *obj, bool recalculateBoundingbox=true)
 
virtual void ReorderObject (unsigned int oldIndex, unsigned int newIndex)
 
virtual void PushObject (DisplayObject *obj)
 
virtual void DeleteVertex (unsigned int index)
 
virtual void InsertVertex (unsigned int index)
 
virtual void SetGroupLocation (const Vertex &v)
 
virtual void GetResources (std::ostream &outstr, GlsResourceFilter *filter=NULL)
 
virtual void CalculateTextureCoordinates (void)
 
virtual void LineWidth (float width)
 
virtual float LineWidth (void)
 
virtual void LineStipplePattern (int pattern)
 
virtual int LineStipplePattern (void)
 
virtual void LineStippleMultiplier (int mult)
 
virtual int LineStippleMultiplier (void)
 
virtual int PolygonMode (void)
 
virtual void PolygonMode (int mode)
 
virtual void PolygonEnd (const int mode)
 
virtual int PolygonEnd (void)
 
virtual void Shading (const int mode)
 
virtual int Shading (void)
 
virtual void DepthTest (unsigned char mode)
 
virtual int DepthTest (void)
 
virtual void AntiAlias (bool mode)
 
virtual bool AntiAlias (void)
 
virtual void AlphaMode (int mode)
 
virtual int AlphaMode (void)
 
virtual void CullBackFace (const bool mode)
 
virtual bool CullBackFace (void)
 
virtual bool LightingEnabled ()
 
virtual void LightingEnabled (bool lighting)
 
virtual void SetBlendColor (const glsColor &color)
 
virtual glsColor GetBlendColor (void)
 
virtual void SetColor (const glsColor &color)
 
virtual glsColor GetColor (void)
 
virtual void SetFillColor (const glsColor &color)
 
virtual glsColor GetFillColor (void)
 
virtual void TextureRepeat (const int rep)
 
virtual bool TextureRepeat (void)
 
virtual void TextureMappingTechnique (const int map)
 
virtual int TextureMappingTechnique (void)
 
virtual void TextureMinificationFilter (const int filter)
 
virtual int TextureMinificationFilter (void)
 
virtual void TextureMagnificationFilter (const int filter)
 
virtual int TextureMagnificationFilter (void)
 
virtual void Calculate (double time)
 
CompatabilityListItemFirst ()
 
CompatabilityListItemLast ()
 
- Public Member Functions inherited from DisplayObject
 DisplayObject (float x, float y, float z)
 
 DisplayObject (const DisplayObject &object, const bool generateNames)
 
virtual ~DisplayObject (void)
 
void Destroy ()
 
void ApplyTextureSettings (int textureIndex=-1)
 
DistiAttribDictAttributes ()
 
void GetBlendColor (unsigned char color[])
 
void GetBlendColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
void SetBlendColor (unsigned char color[])
 
void SetBlendColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
bool BlinkedOff (void)
 
virtual bool Blinking (void)
 
virtual void Blinking (const bool blink)
 
virtual float BlinkRate (void)
 
virtual void BlinkRate (const float rate)
 
const VectorBoundingVolumeCenter () const
 
void BoundingVolumeCenter (const Vector &center)
 
bool BoundingVolumeHit (const Vector &start, const Vector &direction)
 
float BoundingVolumeRadius () const
 
void BoundingVolumeRadius (float radius)
 
void CalculateCollisionPoint (const Vector &pickLoc, const Vector &directionVector, Vector *collisionPoint)
 
virtual void CalculateParentBoundingBox (void)
 
bool GetTexturePointTransformationMatrix (GlsMatrixType &world2tex)
 
CallbackMethodCallerBaseCallbackCaller () const
 
void CallbackCaller (CallbackMethodCallerBase *cb)
 
virtual void GetCenter (Vector &center)
 
void GetColor (unsigned char c4[])
 
void GetColor (unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
 
void SetColor (unsigned char c4[])
 
void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
virtual void CopyHierarchyProperties (DisplayObject *src, bool copyName)
 
bool Culled () const
 
bool CullTest (const GlsMatrixType *matrix, const Culler &culler)
 
GlsMatrixTypeDcsMatrix ()
 
void DcsMatrix (const GlsMatrixType &matrix)
 
const GlsMatrixTypeDrawMatrix ()
 
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 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 DynamicTranslate (float amount, int axis, bool relative=false)
 
virtual float DynamicTranslation (int axis)
 
virtual Vector DynamicTranslation ()
 
DisplayObjectEditor * Editor ()
 
const DisplayObjectEditor * Editor () const
 
void Editor (DisplayObjectEditor *editor)
 
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[])
 
void SetFillColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
void SetFillColor (unsigned char c4[])
 
virtual DisplayObjecthandle (DisplayEvent *ev)
 
virtual bool HitUtil (float x, float y, float z, float scale, Vertex *vertices, unsigned int vertex_cnt, const Vector &directionVector, Vector *collisionPoint)
 
char * InstanceName (void)
 
void InstanceName (const char *name)
 
virtual const VertexLocation (void) const
 
virtual void GetLocation (Vertex &v)
 
virtual void GetLocation (float &x, float &y, float &z)
 
float X (void) const
 
float Y (void) const
 
float Z (void) 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)
 
GlsMatrixTypeModelMatrix ()
 
bool NeedCalculate ()
 
VectorNormals ()
 
virtual void SetNormals (unsigned int nPoints, Vector *vertices)
 
void VaSetNormals (unsigned int nPoints,...)
 
unsigned int NumberOfVertices () const
 
virtual float ObjectDepth (void)
 
virtual float ObjectHeight (void)
 
virtual float ObjectWidth (void)
 
virtual void SetOrigin (const Vertex &vert)
 
DisplayFrameParent (void) const
 
virtual void ParentGroup (Group *group)
 
GroupParentGroup (void) const
 
unsigned char Pickable ()
 
virtual void Pickable (unsigned char pick)
 
GlsMatrixTypeProjMatrix ()
 
virtual void ReallocateVertices (unsigned int numVertices, bool initializeNew, bool copyOld)
 
virtual float RelativeAngle (const float x, const float y)
 
virtual DistiAttributeBaseResource (const char *name)
 
void RestoreAlpha (void)
 
void RestoreAntiAlias (void)
 
void RestoreLighting (void)
 
void RestoreLineStyle (void)
 
const VertexRotationPoint ()
 
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)
 
void SaveMatrices ()
 
void Scale (int handleBar, float px, float py, Vertex *anchor=NULL)
 
void Set (int spec,...)
 
bool SetupAlpha (void)
 
bool SetupAntiAlias (void)
 
void SetupDepthTest (void)
 
void SetupLighting (void)
 
bool SetupLineStyle (void)
 
void SetupPolyDrawStyle (void)
 
void SetupShading (void)
 
bool SetupTexture (void)
 
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,...)
 
VectorTextureCoordinates (void)
 
VectorGetTextureCoordinates (void)
 
virtual int TextureIndex (void)
 
virtual void TextureIndex (int textureIndex)
 
virtual VectorGetTexturePoints (void)
 
virtual void UpdateBoundingVolume (void)
 
void * UserData (void) const
 
void UserData (void *data)
 
virtual void SetVertexColor (unsigned int vertex, unsigned char CurrentFillColor[])
 
virtual VertexVertices ()
 
virtual void SetVertices (unsigned int nPoints, Vertex *vertices)
 
void VaSetVertices (unsigned int nPoints,...)
 
int * ViewMatrix ()
 
bool Visible (void) const
 
bool Visibility (void) const
 
virtual void Visibility (const bool vis)
 
virtual Vector WorldRotationPoint (void)
 
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)
 
virtual bool GetPlaneVectorPoints (Vertex &p1, Vertex &p2, Vertex &p3, Vertex &planeVector)
 
void NotifyAttributeChanged (const AttributeName &name)
 
- Public Member Functions inherited from AttributeChangedNotifier
virtual ~AttributeChangedNotifier ()
 
- Public Member Functions inherited from WeakReferenceableMixin
void AddWeakReference (WeakReference *weakRef)
 
void NotifyWeakReferenceDestroyed (WeakReference *ref)
 

Protected Member Functions

virtual void AddAvailableAttributes (unsigned int availableAttributes)
 
void GrowBoundingBox (DisplayObject *obj)
 
- 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 AllocateModelMatrix ()
 
bool ApplyDynamicRotation (void)
 
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 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 SetValue (int spec, va_list &args)
 
int GetApplicableTextureIndex ()
 
int GetApplicableTextureRepeat ()
 
- Protected Member Functions inherited from WeakReferenceableMixin
 WeakReferenceableMixin (void)
 
virtual ~WeakReferenceableMixin ()
 

Additional Inherited Members

- Public Types inherited from DisplayObject
enum  AvailableAttributesEnum
 
- Static Public Member Functions inherited from DisplayObject
static void UseManualBlinkElapsedTime (bool useManualTime)
 
static void SetManualBlinkElapsedTime (double elapsedTime)
 
- Protected Attributes inherited from DisplayObject
int _alphaMode
 
bool _antiAlias
 
bool _attributesAdded
 
bool _blinking
 
float _blinkRate
 
glsColor _color
 
bool _cullBackFace
 
GlsMatrixType _dcsMatrix
 
unsigned char _depthTest
 
GlsMatrixType_drawMatrix
 
unsigned char _lineStippleMultiplier
 
unsigned short _lineStipplePattern
 
float _lineWidth
 
Vertex _location
 
GlsMatrixType_modelMatrix
 
Vector_normals
 
unsigned int _nTex_vertices
 
unsigned int _nVertices
 
unsigned char _polygonEnd
 
unsigned char _polygonMode
 
int _polygonOffset
 
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
 
- Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > * _weakRefs
 

Detailed Description

The Group class. Implements groups of objects

Constructor & Destructor Documentation

Group ( int  generateInstance = 0)
explicit

Construct a new group.

Parameters
generateInstanceWhether or not to generate an instance name for this group
Group ( const Group group,
bool  generateNames 
)

Copy construct a new group, performing a "deep copy" by cloning objects in the group.

Parameters
groupThe group to clone.
generateNamesWhether or not to generate a new instance name for this group and its children.
virtual ~Group ( )
virtual

Destroy a group object

Member Function Documentation

virtual void AddAvailableAttributes ( unsigned int  availableAttributes)
protectedvirtual

The objects contained in this group Helper method for child classes of group that don't want to call Group::SetAvailableAttributes

virtual void AlphaMode ( int  mode)
virtual

Set the alpha mode state for this object

Parameters
modewhich alpha mode to use when drawing
See also
AlphaMode_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual int AlphaMode ( void  )
virtual

Get the alpha mode for this object

Returns
Whether or not alpha testing or blending is enabled when drawing
See also
AlphaMode_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void AntiAlias ( bool  alias)
virtual

Set the anti aliasing state for this object

Parameters
aliasWhether or not to perform anti aliasing

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual bool AntiAlias ( void  )
virtual

Get the anti aliasing state this object

Returns
Whether or not this object will be drawn antialiased

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void Calculate ( double  time)
virtual

Call the Calculate method for all children

Parameters
timeThe current time

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, GlsRSOWrapper, GlsMutexGroup, and SplashDisplay.

virtual void CalculateTextureCoordinates ( void  )
virtual

Recalculates the texture coordinates for the object based on the TexturePoints.

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable.

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
generateNamesWhether or not to generate new names for cloned objects
Returns
A new object, identical to the original, except for the instance name

Implements DisplayObject.

Reimplemented in Gls3DCable, GlsMimicGroup, GlsRSOWrapper, GlsKnob, GlsSwitch, ComponentBase, SplashDisplay, GlsPushButton, GlsMutexGroup, GlsClippingGroup, GlsOdometer, GlsThumbWheel, and GlsMultiView.

virtual void CopyGeometry ( DisplayObject src)
virtual

Copies the geometry information from one object to another. Used by the undo mechanism to allow user to undo a geometry change.

Parameters
srcThe object to copy geometry from

Reimplemented from DisplayObject.

Reimplemented in GlsRSOWrapper, and ComponentBase.

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
srcThe object to copy properties from

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, GlsMimicGroup, GlsRSOWrapper, GlsKnob, GlsSwitch, ComponentBase, GlsPushButton, GlsMutexGroup, GlsClippingGroup, GlsThumbWheel, GlsOdometer, and GlsMultiView.

unsigned int Count ( void  ) const
inline
Returns
The number of objects in this group. (Non recursive count)
virtual void CullBackFace ( const bool  val)
virtual

Sets if back faces should be removed

Parameters
valTrue if back faces should be removed

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual bool CullBackFace ( void  )
virtual

Returns if back faces should be removed

Returns
True if backfaces are removed

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

bool CullTestChildren ( void  ) const
inline

Returns whether or not this group's children should be considered for culling

void CullTestChildren ( bool  mode)

Sets whether or not this group's children should be considered for culling

virtual void DeleteAllChildren ( )
virtual

Actually delete all the children of the group. This does a recursive "delete" on all the children. This does NOT just remove them from the group.

Reimplemented in ComponentBase.

virtual bool DeleteObject ( DisplayObject obj,
bool  recalculateBoundingbox = true 
)
virtual

Removes the specified object from this group. Does not delete it.

Parameters
objThe display object to removed
recalculateBoundingbox
Returns
True if the object was found and removed from this group
virtual void DeleteVertex ( unsigned int  index)
virtual

DeleteVertex is overloaded in group to disable it. It is not possible to delete a Group's Vertices

Reimplemented from DisplayObject.

virtual void DepthTest ( unsigned char  zbuf)
virtual

Set the z buffering state for this object

Parameters
zbufWhether or not to perform z buffering

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable.

virtual int DepthTest ( void  )
virtual

Get the z buffering state for this object

Returns
Whether or not this object will be draw Z buffered

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void Draw ( void  )
virtual

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

Implements DisplayObject.

Reimplemented in Gls3DCable, GlsMimicGroup, GlsRSOWrapper, ComponentBase, GlsKnob, GlsSwitch, GlsMutexGroup, GlsPushButton, GlsClippingGroup, GlsLodGroup, GlsOdometer, Statistics, GlsThumbWheel, GlsMultiView, and GlsSortedDrawGroup.

DisplayObject* FindByName ( const char *  name)

Finds a pointer to the display object in the group, using the object's instance name as a key.

Note
If there are multiple DisplayObjects within the group with the same name, only the first instance will be found. This can be an issue if a sub-component contains objects with the same name as the object you are searching for.
Parameters
nameInstance name of the object to find
Returns
A pointer to the object if it is in the group, otherwise NULL
DisplayObject* FindByName ( DisplayObject obj)
inline

Finds a pointer to the display object in the group, using the object's instance name as a key.

Parameters
objPointer to the object to find
Returns
A pointer to the object if it is in the group, otherwise NULL
virtual DisplayObject* FindByNameSameFrame ( const char *  name)
virtual

Finds a pointer to the display object in the group, using the object's instance name as a key. This does not desend into components, as they are different frames with possibility for duplicate names as the current frame.

Parameters
nameInstance name of the object to find
Returns
A pointer to the object if it is in the group, otherwise NULL

Reimplemented in ComponentBase.

DisplayObject* FindByQualifiedName ( const char *  name)

Finds a pointer to the DisplayObject in the group using a qualified instance name. This allows precise searches for an object contained within a sub-component. (e.g. "cockpit.altimeter.needle"). To find an object in the same DisplayFrame use just the instance name. (e.g. "cockpit") The dot denotes crossing of DisplayFrame boundaries.

See also
GetQualifiedInstanceName
Parameters
nameQualified instance name of the object to find
Returns
A pointer to the object if it is in the group, otherwise NULL
DisplayObject* FindNonRecursive ( DisplayObject obj)

Finds a pointer to the display object in the group, using the object's address as a key

Parameters
objPointer to the object to find
Returns
A pointer to the object if it is in the group, otherwise NULL
Returns
The first object in this group
DisplayObject* FirstObject ( )
Returns
pointer to the first element in the group, or NULL if it doesn't exist
virtual glsColor GetBlendColor ( void  )
virtual

Gets the texture blend color for the object

Returns
Returns the current texture blend color.

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual glsColor GetColor ( void  )
virtual

Gets the color for the object outline

Returns
The outline color

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual InterfaceListType* GetCppInterfaceDescription ( InterfaceListType addToThisList = NULL)
virtual

Get the details of the Cpp Interface The actual interface is exposed in compiled code.

Parameters
addToThisListIf not NULL this list will be added to then returned. If NULL a new list will be created.
Returns
A templated list. The caller must call the corresponding free method to safely free the memory.

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, GlsMimicGroup, GlsRSOWrapper, GlsKnob, GlsSwitch, ComponentBase, GlsPushButton, SplashDisplay, GlsMutexGroup, GlsClippingGroup, GlsOdometer, GlsThumbWheel, and GlsMultiView.

virtual void GetCppInterfaceDescriptionFree ( InterfaceListType array)
virtual

Frees the memory allocated by a previous call to GetCppInterfaceDescription

Parameters
arrayMemory allocated by a previous call to GetCppInterfaceDescription

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, GlsMimicGroup, GlsRSOWrapper, GlsKnob, GlsSwitch, ComponentBase, GlsPushButton, SplashDisplay, GlsMutexGroup, GlsClippingGroup, GlsOdometer, GlsThumbWheel, and GlsMultiView.

virtual void GetExtents ( float &  x,
float &  y,
float &  z,
float &  x1,
float &  y1,
float &  z1 
)
virtual

Figure out the static extents for the object. Used by the editor as part of the pick operation and for figuring out the size of groups.

Parameters
xGets the minimum x extent
yGets the minimum y extent
zGets the minimum z extent
x1Gets the maximum x extent
y1Gets the maximum y extent
z1Gets the maximum z extent

Reimplemented from DisplayObject.

Reimplemented in GlsRSOWrapper, and ComponentBase.

virtual glsColor GetFillColor ( void  )
virtual

Gets the fill color of the object

Returns
The fill color

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable.

virtual void GetResources ( std::ostream &  outstr,
GlsResourceFilter filter = NULL 
)
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
outstrThe stream to write to
filterThe filter to determine what to write

Reimplemented from DisplayObject.

Reimplemented in ComponentBase, Gls3DCable, GlsRSOWrapper, and GlsMultiView.

virtual void GetTransformedExtents ( Vector min,
Vector max,
const GlsMatrixType matrix,
bool  resetMinMax = true 
)
virtual

Determines the static extents of the geometry projected to the XY plane of an arbirary coordinate system.

Parameters
minReturns the minimum values found in the traversal
maxReturns the maximum values found in the traversal
matrixTransformation matrix from logical coordinates to the coordinate system to determine the extents in.
resetMinMaxNormally not specified by user. Should be true for the initial call.

Reimplemented from DisplayObject.

Reimplemented in ComponentBase, and GlsRSOWrapper.

void GrowBoundingBox ( DisplayObject obj)
protected

Grow bounding box to accomodate new object

Parameters
objThe new object in the group
Precondition
obj Must already be added to the group
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
xX coordinate of pick ray start in logical coordinates.
yY coordinate of pick ray start in logical coordinates.
yY coordinate of pick ray start in logical coordinates.
zZ coordinate of pick ray start in logical coordinates.
scaleThe scale factor of the window. Affects picking of outlines. Standard value is 1.0.
directionVectorThe direction of the pick ray.
collisionPointIf 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.

Reimplemented in Gls3DCable.

void InitialGroupCount ( unsigned int  cnt)

Sets the initial number of entries in a group

Parameters
cntThe initial number of entries
virtual void InsertObject ( DisplayObject obj,
bool  reparent = true,
bool  recalculateBoundingbox = true,
int  loc = -1 
)
virtual

Adds the specified object into the group, at the end of the list

Parameters
objA pointer to the object to add
reparentWhether or not the object parent should be set to this group
recalculateBoundingboxWhether or not to recalculate the bounding box
locWhere to insert it (defaults to -1 which means at the end of the list)

Reimplemented in GlsLodGroup.

virtual void InsertVertex ( unsigned int  index)
virtual

InsertVertex is overloaded in group to disable it. It is not possible to insert into a Group's Vertices

Reimplemented from DisplayObject.

bool IsEmpty ( void  ) const
inline
Returns
True if this group is empty
DisplayObject* Item ( unsigned int  index)
inline

Returns the DisplayObject at the given group index

Returns
The last object in this group
DisplayObject* LastObject ( void  )
Returns
pointer to the last element in the group, or NULL if it doesn't exist
virtual bool LightingEnabled ( )
virtual

Gets the lighting state

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void LightingEnabled ( bool  lighting)
virtual

Sets the lighting state

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void LineStippleMultiplier ( int  mult)
virtual

Set the line stipple multiplier for this object

Parameters
multThe new line stipple pattern

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual int LineStippleMultiplier ( void  )
virtual

Get the line stipple multiplier for this object

Returns
The line stipple multiplier for this object

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void LineStipplePattern ( int  pattern)
virtual

Set the line stipple pattern for this object

Parameters
patternThe new line stipple pattern

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual int LineStipplePattern ( void  )
virtual

Get the line stipple pattern for this object

Returns
The line stipple pattern for this object

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void LineWidth ( float  width)
virtual

Sets the width of lines in the object.

Parameters
widthThe new line width of the object in logical units

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual float LineWidth ( void  )
virtual

Gets the width of lines in the object.

Returns
The line width of the object in logical units

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void Location ( const Vertex v)
virtual

Sets the location of the origin of the object

Parameters
vThe new location

Reimplemented from DisplayObject.

Reimplemented in ComponentBase.

virtual void Location ( float  x,
float  y,
float  z 
)
virtual

Sets the location of the origin of the object

Parameters
xX Coordinate of the new location
yY Coordinate of the new location
zZ Coordinate of the new location

Reimplemented from DisplayObject.

Reimplemented in ComponentBase.

DisplayObjectArray& Objects ( void  )
inline

Returns a reference to the object array for this group

DisplayObjectPtr operator[] ( unsigned int  index)
inline

Overload of the array index operator to allow you to treat this Group as an array of objects

virtual void Parent ( DisplayFrame par)
virtual

Sets the parent display frame pointer for this object to the indicated display frame

Parameters
parThe new display frame to be the parent object

Reimplemented from DisplayObject.

Reimplemented in ComponentBase.

bool PerformGroupCullCheck ( void  ) const
inline

Returns whether or not this group should be considered for culling

void PerformGroupCullCheck ( bool  mode)

Sets whether or not this group should be considered for culling

virtual DisplayObject* Pick3D ( const Vector winLoc,
const Vector logicalCoords,
float  scale,
const Vector directionVector,
Vector collisionWinLoc,
const OpenGLMatrices drawnMatrices 
)
virtual

Attempts to pick an object in 3D and accounting for dynamic rotations and translations of this object or parent objects. It also looks at the pickable status and attempts to return the "Best" pick if that is what is desired.

Note: This method will pick objects in the scene based on a pick ray starting at winLoc and pointing into the screen. It will not pick objects behind the depth specified by winLoc.z. Typically winLoc.z should be set to 0 to ensure that the pick ray starts at near clip plane.

Parameters
winLocDevice coordinates for the mouse click. Z value should be set to 0 to ensure pick ray starts at near clip plane.
logicalCoordsThe start of the pick ray in logical coordinates. Should be calculated from the winLoc using this->WindowToLogical(winLoc, logicalCoords, &directionVector).
scaleCurrent window scale. Affects picking radius of outlines. Initial value should typically be 1.0.
directionVectorThe direction of the pick ray in logical coordinates. Should be calculated from the winLoc using this->WindowToLogical(winLoc, logicalCoords, &directionVector).
collisionWinLocReturns where the pick vector intersects the object that is hit in device coordinates.
drawnMatricesThe matrices used to draw the object, including matrices set by parents that may have dynamically rotated, translated or scaled this object. Initial value should typically be a default OpenGLMatrices() object.
Returns
The object that was hit, or NULL if no object hit

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, ComponentBase, GlsRSOWrapper, GlsThumbWheel, GlsMutexGroup, GlsPushButton, GlsClippingGroup, and GlsMultiView.

virtual void PolygonEnd ( const int  end)
virtual

Sets the polygon end mode (Open or Closed) for the polygon

Parameters
endEnumeration indicating open or closed mode
See also
PolygonClose_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual int PolygonEnd ( void  )
virtual

Gets the polygon end mode (Open or Closed) for the polygon

Returns
Enumeration indicating open or closed mode
See also
PolygonClose_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual int PolygonMode ( void  )
virtual

Gets the polygon drawing mode for this object

Returns
The polygon drawing mode for this object
See also
PolygonMode_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void PolygonMode ( int  mode)
virtual

Sets the polygon drawing mode for this object

Parameters
modeThe new polygon drawing mode for this object
See also
PolygonMode_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

int Position ( DisplayObject obj)

Get the index position of the specified object in the list

Parameters
objThe object to find
Returns
The index of the object in the list, -1 if it isn't in the list
virtual void PreDraw ( const OpenGLMatrices current,
Culler culler 
)
virtual

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

Parameters
currentCurrent matrices inherited from parent
cullerObject that possibly marks this object for culling

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, ComponentBase, GlsRSOWrapper, GlsKnob, GlsSwitch, GlsMutexGroup, GlsPushButton, GlsLodGroup, GlsOdometer, Statistics, GlsThumbWheel, and GlsMultiView.

virtual void PushObject ( DisplayObject obj)
virtual

Adds the specified object into the group, at the head of the list Treats the list like a stack, hence the name Push

Parameters
objA pointer to the object to add
virtual void ReorderObject ( unsigned int  oldIndex,
unsigned int  newIndex 
)
virtual

Change the draw order of a child object within this group

Parameters
oldIndexThe old index of the object
newIndexThe new index of the object
Precondition
oldIndex and newIndex must be valid indices
virtual void Rotate ( const Vector orig,
float  angle,
const Vector axis 
)
virtual

Rotates the object (around the specified axis) by the angle indicated, at the point specified. Recalculates the vertex data.

Parameters
origThe point to rotate around
angleThe angle to rotate by, in degrees
axisThe arbitrary axis to rotate the object around

Reimplemented from DisplayObject.

Reimplemented in ComponentBase.

virtual void Scale ( float  px,
float  py,
float  pz,
Vertex anchor = NULL,
int  handleBar = 0 
)
virtual

Scales the object, either the handleBar, or the Anchor is used to translate the object, not both. Anchor takes presidence, if it is set HandleBar is ignored. The footprint is different from the 2D scale so the compiler can destinguish the two.

Parameters
pxValue of the percentage of scale in x-axis
pyValue of the percentage of scale in y-axis
pzValue of the percentage of scale in z-axis
anchorAnchor from which to scale object relative to
handleBarVertex that is being dragged

Reimplemented from DisplayObject.

Reimplemented in ComponentBase.

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
valueA bitfield specifying which types of attributes to make available.
See also
AvailableAttributesEnum

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, GlsMimicGroup, GlsKnob, GlsSwitch, GlsPushButton, GlsMutexGroup, GlsLodGroup, GlsClippingGroup, GlsOdometer, GlsThumbWheel, GlsMultiView, and ComponentBase.

virtual void SetBlendColor ( const glsColor color)
virtual

Sets the texture blend color for the object

Parameters
colorA glsColor

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void SetColor ( const glsColor color)
virtual

Sets the RGBA color for the object outline

Parameters
colorThe new color

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void SetFillColor ( const glsColor color)
virtual

Sets the RGBA color for filling the object

Parameters
colorThe new RGBA fill color (0-255 range) for the object

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable.

virtual void SetGroupLocation ( const Vertex v)
virtual

Copies the given vertex data into the group's location vertex thereby moving the group's location member without affecting its child objects.

Parameters
v- Given vertex
virtual void Shading ( const int  shading)
virtual

Sets the polygon shading mode (Flat or gouraud) for the polygon

Parameters
shadingEnumeration indicating shading mode
See also
ShadingType_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual int Shading ( void  )
virtual

Gets the polygon shading mode (Flat or gouraud) for the polygon

Returns
Enumeration indicating shading mode
See also
ShadingType_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void TextureMagnificationFilter ( const int  filter)
virtual

Sets the texture magnification filter for this object

Parameters
filterThe new texture magnification filter for this object
See also
TextureFilter_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual int TextureMagnificationFilter ( void  )
virtual

Gets the texture magnification filter for this object

Returns
The texture magnification filter for this object
See also
TextureFilter_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void TextureMappingTechnique ( const int  map)
virtual

Sets the texturing mapping mode for this object

Parameters
mapThe new texture mapping mode for this object
See also
TextureMap_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual int TextureMappingTechnique ( void  )
virtual

Gets the texturing mapping mode for this object

Returns
The texture mapping mode for this object
See also
TextureMap_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void TextureMinificationFilter ( const int  filter)
virtual

Sets the texture minification filter for this object

Parameters
filterThe new texture minification filter for this object
See also
TextureFilter_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual int TextureMinificationFilter ( void  )
virtual

Gets the texture minification filter for this object

Returns
The texture minification filter for this object
See also
TextureFilter_e

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void TextureRepeat ( const int  rep)
virtual

Sets the texturing repeat mode for this object

Parameters
repThe new texture repeat mode for this object (boolean)

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual bool TextureRepeat ( void  )
virtual

Gets the texturing repeat mode for this object

Returns
The texture repeat mode for this object

Reimplemented from DisplayObject.

Reimplemented in Gls3DCable, and GlsRSOWrapper.

virtual void Translate ( float  x,
float  y,
float  z 
)
virtual

Moves the object by the amount indicated.

Parameters
xX amount to translate by
yY amount to translate by
zZ amount to translate by

Reimplemented from DisplayObject.

Reimplemented in ComponentBase.

virtual void Translate ( float  tr[])
virtual

Moves the object by the amount indicated.

Parameters
trFloat[3] array containing the x,y,z amounts to translate by

Reimplemented from DisplayObject.

Reimplemented in ComponentBase.

virtual void TranslateVertices ( float  x,
float  y,
float  z 
)
virtual

Moves the object's vertices by the amount indicated. Does not change _location.

Parameters
xX amount to translate by
yY amount to translate by
zZ amount to translate by

Reimplemented from DisplayObject.


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