pfvDispView(3pf) OpenGL Performer 3.2.2 libpfv C++ Reference Pages
NAMEpfvDispView - Configure one or more views through an XML file or API
calls. .
FUNCTION SPECIFICATION
#include <Performer/pfv/pfvDisplay.h>
virtual int pfvDispView::config();
virtual int pfvDispView::setXmlField(pfvXmlNode* xml);
int pfvDispView::getNumChans();
pfvDispChan* pfvDispView::getChan(int i);
pfvDispChan* pfvDispView::findChan(char* _name);
virtual int pfvDispView::addChan(pfvDispChan* chan);
uint64_t pfvDispView::getChanMask();
pfChannel* pfvDispView::getMasterChan();
virtual int pfvDispView::setMasterChan(pfvDispChan* chan);
virtual int pfvDispView::setMasterChan(pfChannel* chan);
virtual uint pfvDispView::setChanShare(uint mask);
uint pfvDispView::getChanShare();
virtual int pfvDispView::setScene(pfScene* _scene);
pfScene* pfvDispView::getScene();
virtual void pfvDispView::setEye( pfVec3& xyz, pfVec3& hpr );
void pfvDispView::getEye( pfVec3&xyz, pfVec3&hpr );
PARENT CLASS FUNCTIONS
The OpenGL Performer class pfvDispView is derived from the parent class
pfvObject, so each of these member functions of class pfvObject are also
directly usable with objects of class pfvDispView. This is also true for
ancestor classes 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
pfvDispView(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 pfvDispView 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 pfvDispView 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();
DESCRIPTION
The pfvDispView class is used to group one or more channels together in
applications based on the pfvDisplayMngr class. Channels belonging to the
same view are intended to always display the same scene from a common
view point. Channels may belong to multiple pipewindows on multiple
pipes, and each channel may have its own view offset values. Note that
multiple views can be created and managed within a single application.
pfvDispView::config will set up master-slave relationship between its
channels (see man page for pfChannel::attach and pfChannel::setShare).
Note that pfvDispView::config is automatically called from within
pfvDisplayMngr::config and should not usually be called by application
code.
Page 2
pfvDispView(3pf) OpenGL Performer 3.2.2 libpfv C++ Reference Pages
pfvDispView::setXmlField will look at the name of the xml node passed as
an argument, and will configure the corresponding attribute of the
pfvDispView object based on the contents of the pfvXmlNode. Currently,
only the <chan> tag will be recognized by pfvDispView::setXmlField.
<chan> tags may be passed on to pfvDispView::setXmlField in order to
assign an existing pfvDispChan to this pfvDispView. Each <chan> tag must
be in the following format:
<chan chan="channel_name"></chan>
where 'channel_name" is the name assigned to a previously created
pfvDispChan object which will be assigned to this view.
pfvDispView::getNumChans returns the number of pfvDispChannels currently
assigned to view.
pfvDispView::getChan returns a handle to the ith channel in view's chan-
list if i is a valid index, NULL otherwise.
pfvDispView::findChan returns a handle to the first channel in view's
chan-list whose name matches _name. If no channel in view's chan-list
matches, NULL is returned.
pfvDispView::addChan adds channel chan to view's chan-list. If channel is
already in view's chan-list, it will not be added again. Method returns 1
if channel was added to view's list, 0 otherwise.
pfvDispView::getChanMask returns a uint64_t bitmask indicating which
channels are part of this view. Each bit in returned value represents a
pfvDisplayChan. The ith channel in Display Manager's global chan-list
will correspond to bit with value (1<<chanindex).
pfvDispView::getMasterChan returns the pfChannel handle associated with
the master pfvDispChannel of a view.
pfvDispView::setMasterChan(pfvDispChan* chan) is used to specify which of
the channels belonging to a view will act as master. By default, the
first channel in view's chan-list will be the master channel. chan must
be one of the channels already associated to view. Method returns 1 if
chan was found in view's chan-list, 0 otherwise.
pfvDispView::setMasterChan(pfChannel* chan) allows the master channel for
a view to be specified by passing a handle to a pfChannel object. The
provided pointer must point to a pfChannel associated with one of the
pfvDispChans already associated to view. Method returns 1 if chan
argument was valid, 0 otherwise.
The mask argument to pfvDispView::setChanShare specifies which attributes
are shared by the channels belonging to view. See man page for
pfChannel::setShare.
Page 3
pfvDispView(3pf) OpenGL Performer 3.2.2 libpfv C++ Reference Pages
pfvDispView::getChanShare returns the share mask of the channel group
associated with this view. See man page for pfChannel::getShare.
pfvDispView::setScene set the pfScene that all channels in view will cull
and draw. See man page for pfChannel::setScene.
pfvDispView::getScene returns the scene currently associated with all
channels in view's chan-list.
pfvDispView::setEye sets the viewing position and orientation for view.
See man page for pfChannel::setView.
pfvDispView::getEye may be used to retreive the current viewing position
and orientation for channels in view. See man page for
pfChannel::getView.
NOTESSEE ALSO
pfvXml, pfvDisplayMngr, pfvViewer, pfvDispChan, pfvView, pfChannel
Page 4
