class TdGfxPfGroup : public TcGfxGroup

Class TdGfxPfGroup

Inheritance:

Public Methods

TdGfxPfGroup(const TcUtString &name, const LoadState &initialLoadState, TcGfxPfComponentAdapter *dspLibComp)
Constructor
virtual ~TdGfxPfGroup()
Destructor
virtual void unLoadGeometry()
This function unloads all children of this node, removing them from memory
virtual void loadGeometry(const LoadType &ldType = ASYNC)
This function loads all children of this node
virtual void hideGeometry()
Sets the APP, DRAW and ISECT masks to 0
virtual void unHideGeometry()
Restores the APP,DRAW, ISECT masks to their state at the time of the the call to hideGeometry
virtual int addChild(TcGfxComponent *gfxNode)
Add a TcGfxComponent to the child list
virtual int removeChild(TcGfxComponent *gfxNode)
Remove a TcGfxComponent from the child list
virtual TcUtVector3f getPosition()
Not yet implemented.
virtual int setPosition(TcUtVector3f)
Not yet implemented.
virtual TcUtVector3f getOrientation()
Not yet implemented.
virtual int setOrientation(TcUtVector3f)
Not yet implemented.
virtual void accept(TcGfxVisitor &v)
Visitor pattern method

Inherited from TcGfxGroup:

Public Methods

const TcGfxGroup& operator=(const TcGfxGroup &right)
TcIterator <TcGfxComponent *> * getChildIterator()
virtual const TcGfxComponent* getCompByName(const TcUtString &name)

Inherited from TcGfxComponent:

Public Classes

enum LoadType
enum LoadState

Public Methods

virtual void toggleLoadGeometry()
virtual void toggleHideGeometry()
virtual void triggerEvent(const TcUtString &eventName)
virtual TcActionEvent* getEvent(const TcUtString &eventName)
virtual TcActionEvent* getIterativeEvent(const TcUtString &eventName)
virtual void handleIterativeEvents()
const TcUtString& getCompName()
void addEvent(TcActionEvent *)
void removeEvent(TcActionEvent *)
void addIterativeEvent(TcActionEvent *)
void removeIterativeEvent(TcActionEvent *)
void addUserComponent(const TcUtString &name, TcUserComponent *component)
TcUserComponent* getUserComponent(const TcUtString &name)
void removeUserComponent(const TcUtString &)
const vector <TcActionEvent *> * getEventList()
TcUtString getGeoFileName()
void setGeoLoaded(bool)
void setGeoHidden(bool)
void setCompName(const TcUtString &name)
bool geoLoaded()
bool geoHidden()
TcGfxComponent* getParent()
void setParent(TcGfxComponent *)
void setDspLibComponent(TcGfxDspLibComponent *)
TcGfxDspLibComponent* getDspLibComponent() const

Protected Fields

TcUtString geometryFileName

Documentation

Class TdGfxPfGroup. This class is used to encapsulate groups of performer graphics components. It provides recursive operations that traverse its children. Its TcGfxDspLibComponent is generally an instances of TdGfxPfGroupAdapter or any of its descendants.

Role: This is a Development Graphics Group. Clients can use this class as is or inherit from it and extend its functionality. The grouping in this class specifies the load hierarchy. hierarchy. The load hierarchy can be used to partition the environment (swap objects in and out of performer memory) or define priorities (load surrounding objects based on proximity. The view hierarchy specfies the structure of the scene graph.

Responsibilities: This class must implement the load and unload methods that operate on a list of children.

TdGfxPfGroup(const TcUtString &name, const LoadState &initialLoadState, TcGfxPfComponentAdapter *dspLibComp)
Constructor.
Parameters:
name - This name defines the name used for searches on the TcGfxComponent tree. It must be unique in the entire tree to which it is to be edded.
initialLoadState - Groups to be asynchronously loaded should be set to UNLOADED and loadGeometry(ASYNC) call should be made after all the children have been added to the group.

virtual ~TdGfxPfGroup()
Destructor. This will take care of deleting all its children.

virtual void unLoadGeometry()
This function unloads all children of this node, removing them from memory. Performer's caching may sabotage certain unload efforts.

virtual void loadGeometry(const LoadType &ldType = ASYNC)
This function loads all children of this node
Parameters:
ldType - An argument of SYNC will perform a synchronous load causing the program to stop responding in the interim. An argument of ASYNC will perform an asynchronous load of all children.

virtual void hideGeometry()
Sets the APP, DRAW and ISECT masks to 0

virtual void unHideGeometry()
Restores the APP,DRAW, ISECT masks to their state at the time of the the call to hideGeometry

virtual int addChild(TcGfxComponent *gfxNode)
Add a TcGfxComponent to the child list
Parameters:
gfxNode - If this node is loaded its pfNode will be added to the scene by attaching it to the underlying pfGroup.

virtual int removeChild(TcGfxComponent *gfxNode)
Remove a TcGfxComponent from the child list. This method must be called to remove a child from a parent before The child is deleted.

virtual TcUtVector3f getPosition()
Not yet implemented.

virtual int setPosition(TcUtVector3f)
Not yet implemented.

virtual TcUtVector3f getOrientation()
Not yet implemented.

virtual int setOrientation(TcUtVector3f)
Not yet implemented.

virtual void accept(TcGfxVisitor &v)
Visitor pattern method. This will call v->visitGfxPfGroup to any visitor resulting in type laundering and implements a special case of double dispatching.

This class has no child classes.

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de