pfvmSceneTree(3pf) OpenGL Performer 3.2.2 libpfv C++ Reference Pages
NAMEpfvmSceneTree - sceneTree module for pfvViewer
FUNCTION SPECIFICATION
#include <Performer/pfvm/pfvmSceneTree.h>
pfvmSceneTree::pfvmSceneTree(pfvXmlNode* xml=NULL);
PARENT CLASS FUNCTIONS
The OpenGL Performer class pfvmSceneTree is derived from the parent class
pfvModule, so each of these member functions of class pfvModule are also
directly usable with objects of class pfvmSceneTree. This is also true
for ancestor classes of class pfvModule.
int pfvModule::getScope();
int pfvModule::getScopeIndex();
pfvObject* pfvModule::getScopeTarget();
int pfvModule::autoScope( int*scopeIndex );
void pfvModule::bindCallback(int which);
void pfvModule::unbindCallback(int which);
int pfvModule::getCBMask();
virtual void pfvModule::preConfig();
virtual void pfvModule::postConfig();
virtual void pfvModule::enterView(pfvView*v);
virtual void pfvModule::exitView(pfvView*v);
virtual void pfvModule::enterWorld();
virtual void pfvModule::exitWorld();
virtual void pfvModule::sync();
virtual void pfvModule::frame();
virtual void pfvModule::preCull(pfvDispChan*chan);
virtual void pfvModule::postCull(pfvDispChan*chan);
virtual void pfvModule::preDraw(pfvDispChan*chan);
virtual void pfvModule::postDraw(pfvDispChan*chan);
virtual void pfvModule::overlay(pfvDispChan*chan);
int pfvModule::bindKeys(char*keys);
int pfvModule::unbindKeys(char*keys)
char* pfvModule::getEventMask()
void pfvModule::setEventMask(char* str);
virtual int pfvModule::handleEvent(int evType, char key);
uint64_t pfvModule::getViewMask();
Since the class pfvModule is itself derived from the parent class
pfvobject, objects of class pfvmSceneTree can also be used with these
functions designed for objects of class pfvobject.
virtual int pfvObject::parseXml(pfvXmlNode*xml);
virtual int pfvObject::setXmlField(pfvXmlNode*xml);
char* pfvObject::getName();
void pfvObject::setName(char*_name);
Page 1
pfvmSceneTree(3pf) OpenGL Performer 3.2.2 libpfv C++ Reference Pages
Since the class pfvobject is itself derived from the parent class
pfObject, objects of class pfvmSceneTree can also be used with these
functions designed for objects of class pfObject.
void* pfObject::operator new(size_t);
void* pfObject::operator new(size_t, pfFluxMemory *fmem);
void pfObject::setUserData(void *data);
void pfObject::setUserData(int slot, void *data);
void* pfObject::getUserData(pfObject *obj);
void* pfObject::getUserData(pfObject *obj, int slot);
int pfObject::getNumUserData();
Since the class pfObject is itself derived from the parent class
pfMemory, objects of class pfvmSceneTree can also be used with these
functions designed for objects of class pfMemory.
void* pfMemory::getData(const void *ptr);
pfType * pfMemory::getType();
int pfMemory::isOfType(pfType *type);
int pfMemory::isExactType(pfType *type);
const char * pfMemory::getTypeName();
int pfMemory::copy(pfMemory *src);
int pfMemory::compare(const pfMemory *mem);
void pfMemory::print(uint which, uint verbose, char *prefix,
FILE *file);
int pfMemory::getArena(void *ptr);
void* pfMemory::getArena();
int pfMemory::ref();
int pfMemory::unref();
int pfMemory::unrefDelete();
int pfMemory::unrefGetRef();
int pfMemory::getRef();
int pfMemory::checkDelete();
int pfMemory::isFluxed();
void * pfMemory::getArena();
int pfMemory::getSize();
DESCRIPTIONpfvmSceneTree is a module that uses the pfuDrawTree functionality to
display a graph representing the current scene in pfvViewer applications.
Currently, pfvmSceneTree can only be configured through XML tokens.
========
XML tags
========
The following tokens are valid inside the <data> XML tag for
Page 2
pfvmSceneTree(3pf) OpenGL Performer 3.2.2 libpfv C++ Reference Pages
pfvmSceneTree modules:
<module>
<class>pfvmSceneTree</class>
<data>
<OnOff>bool</OnOff>
<Key>string</Key>
<panX>float</panX>
<panY>float</panY>
<scale>float</scale>
</data>
</module>
<OnOff>bool</OnOff>, where bool specifies whether the sceneTree graph
should be initially displayed. The default is 0.
<Key>string</Key>, where string identifies the key that will toggle the
overlay display the sceneTree graph. See man page for
pfvInputMngr::getKeyName() and pfvinput.h for a complete list of keys and
associated strings. The default key is 'h'.
<panX>float</panX>, where float specifies the initial value of the
horizontal pan used to display the sceneTree graph. the default value is
0.0.
<panY>float</panY>, where float specifies the initial value of the
horizontal pan used to display the sceneTree graph. the default value is
0.0.
<scale>float</scale>, where float specifies the initial scale value used
to display the sceneTree graph. the default value is 1.0.
Note that the pfvmSceneTree module will additionally respond to user
keypresses on the cursor keys, in the following way:
LEFTARROW, RIGHTARROW:
decrement and increment panX (scroll left and right respectively).
UPARROW, DOWNARROW:
decrement and increment panY (scroll up and down respectively).
shift+UPARROW, shift+DOWNARROW:
increment and decrement scale.
Page 3
pfvmSceneTree(3pf) OpenGL Performer 3.2.2 libpfv C++ Reference Pages
SEE ALSO
pfvModule, pfvViewer, pfuDrawTree, pfvXml
Page 4
