VIS_Handle Class Reference

#include <VIS_Handle.h>

Public Member Functions
	VIS_Handle (int unique_id=-1)
bool	isValid ()
bool	operator== (const VIS_Handle vh) const
bool	operator!= (const VIS_Handle vh) const
int	getUniqueId () const
int	getTypeId ()
	Returns the type id of the mounted visualizer. More...
PRM_ParmList *	getParmList ()
	returns the parameter list of the mounted visualizer. More...
VIS_Visualizer *	getVisualizer ()
	Returns the mounted visualizer. More...
int	getSerialNum ()
	Returns the serial number of the mounted visualizer. More...
VIS_TableRef	getTableRef () const
	Returns the table ref of the VIS_Tables that owns the mount. More...
int	getIndex () const
	Returns the index of the viuslaizer in the owning VIS_Table. More...
const char *	getName () const
const char *	getLabel () const
const char *	getIcon () const
bool	isActiveWhenUnselected () const
bool	isActiveWhenSelected () const
bool	isActiveWhenGhosted () const
bool	isActiveWhenDisplayed () const
bool	isActiveWhenCurrent () const
bool	isActiveWhenTemplated () const
bool	showInToolbar () const
VIS_VisualizerScope	getScope () const
VIS_Mount *	getMount () const

Detailed Description

Definition at line 28 of file VIS_Handle.h.

Constructor & Destructor Documentation

VIS_Handle::VIS_Handle ( int  unique_id = -1 )

inline

Definition at line 31 of file VIS_Handle.h.

Member Function Documentation

const char* VIS_Handle::getIcon

(

)

const

int VIS_Handle::getIndex

(

)

const

Returns the index of the viuslaizer in the owning VIS_Table.

const char* VIS_Handle::getLabel

(

)

const

VIS_Mount* VIS_Handle::getMount ( ) const

inline

Definition at line 80 of file VIS_Handle.h.

const char* VIS_Handle::getName

(

)

const

PRM_ParmList* VIS_Handle::getParmList

(

)

returns the parameter list of the mounted visualizer.

VIS_VisualizerScope VIS_Handle::getScope

(

)

const

int VIS_Handle::getSerialNum

(

)

Returns the serial number of the mounted visualizer.

VIS_TableRef VIS_Handle::getTableRef

(

)

const

Returns the table ref of the VIS_Tables that owns the mount.

int VIS_Handle::getTypeId

(

)

Returns the type id of the mounted visualizer.

int VIS_Handle::getUniqueId

(

)

const

Returns a the mount's unique id (this doesn't change if the mounted visualizer is substituted).

VIS_Visualizer* VIS_Handle::getVisualizer

(

)

Returns the mounted visualizer.

bool VIS_Handle::isActiveWhenCurrent

(

)

const

bool VIS_Handle::isActiveWhenDisplayed

(

)

const

bool VIS_Handle::isActiveWhenGhosted

(

)

const

bool VIS_Handle::isActiveWhenSelected

(

)

const

bool VIS_Handle::isActiveWhenTemplated

(

)

const

bool VIS_Handle::isActiveWhenUnselected

(

)

const

bool VIS_Handle::isValid ( )

inline

Definition at line 35 of file VIS_Handle.h.

bool VIS_Handle::operator!= ( const VIS_Handle  vh ) const

inline

Definition at line 41 of file VIS_Handle.h.

bool VIS_Handle::operator== ( const VIS_Handle  vh ) const

inline

Definition at line 38 of file VIS_Handle.h.

bool VIS_Handle::showInToolbar

(

)

const

---

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

• VIS/VIS_Handle.h