makVrv::DtBaseQuadAttribute Class Reference

Attribute that generates a colored quad. More...

Inheritance diagram for makVrv::DtBaseQuadAttribute:

Public Member Functions
	DtBaseQuadAttribute (DtDe &de)
	CTOR.
virtual	~DtBaseQuadAttribute ()
	DTOR.
virtual void	setOffset (double x, double y)
	Set the position of the attribute (generally the top left corner).
virtual void	setPosition (float x, float y, float z, float w)
	Set the position of the attribute in world space.
virtual void	getMinSize (double &xOut, double &yOut)
	Get the minimum size of the attribute.
virtual void	setSize (double x, double y)
	Set the size of the attribute.
virtual void	setColor (float r, float g, float b, float a)
	Set the color of the attribute.
virtual void	setShadowText (bool enabled)
	Set whether attribute text should have shadows.
virtual void	setVisible (bool visible)
	Set the attribute visible or hidden.
virtual bool	visible () const
	Get the visibility of the attribute.
virtual DtQuad *	quad ()
	Get the underlying quad.
virtual void	setOverlay (unsigned int overlayId)
	Set the overlay type this attribute will render in.
virtual void	setGroup (unsigned int group)
	Set the group to draw the atribute on.
Public Member Functions inherited from makVrv::DtAttribute
	DtAttribute ()
	CTOR.
virtual	~DtAttribute ()
	DTOR.
virtual void	setForegroundGroup (unsigned int group)
	Set the group to draw the atribute's foreground on.
virtual void	setBackgroundGroup (unsigned int group)
	Set the group to draw the atribute's background on.

Protected Member Functions
virtual void	updateQuad ()
	Render the attribute and update the dimensions and color.

Protected Attributes
DtQuad *	myQuad
DtDe &	myDe
float	myX
float	myY
float	myZ
float	myW
double	myOffsetX
double	myOffsetY
float	myR
float	myG
float	myB
float	myA
double	mySizeX
double	mySizeY
bool	myVisible
unsigned int	myOverlay

Additional Inherited Members
Public Attributes inherited from makVrv::DtAttribute
boost::signal< void(DtAttribute *, double, double)>	signal_sizeChanged
	Emitted when the attribute's size changes.

Detailed Description

Attribute that generates a colored quad.

Note

This class is intended for derivation or composition.

Constructor & Destructor Documentation

makVrv::DtBaseQuadAttribute::DtBaseQuadAttribute

(

DtDe &

de

)

CTOR.

virtual makVrv::DtBaseQuadAttribute::~DtBaseQuadAttribute ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtBaseQuadAttribute::setOffset ( double  x, double  y  )

virtual

Set the position of the attribute (generally the top left corner).

Reimplemented from makVrv::DtAttribute.

virtual void makVrv::DtBaseQuadAttribute::setPosition ( float  x, float  y, float  z, float  w  )

virtual

Set the position of the attribute in world space.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseQuadAttribute::getMinSize ( double &  xOut, double &  yOut  )

virtual

Get the minimum size of the attribute.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseQuadAttribute::setSize ( double  x, double  y  )

virtual

Set the size of the attribute.

The size is clamped to no less than the minimum size.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseQuadAttribute::setColor ( float  r, float  g, float  b, float  a  )

virtual

Set the color of the attribute.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseQuadAttribute::setShadowText ( bool  enabled )

virtual

Set whether attribute text should have shadows.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseQuadAttribute::setVisible ( bool  visible )

virtual

Set the attribute visible or hidden.

Implements makVrv::DtAttribute.

virtual bool makVrv::DtBaseQuadAttribute::visible ( ) const

virtual

Get the visibility of the attribute.

Implements makVrv::DtAttribute.

virtual DtQuad* makVrv::DtBaseQuadAttribute::quad ( )

virtual

Get the underlying quad.

virtual void makVrv::DtBaseQuadAttribute::setOverlay ( unsigned int  overlayId )

virtual

Set the overlay type this attribute will render in.

Overlay ids should be one of DtOverlayManager::DefaultOverlays.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseQuadAttribute::setGroup ( unsigned int  group )

virtual

Set the group to draw the atribute on.

The group specifies the z order of the attribute on the overlay.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseQuadAttribute::updateQuad ( )

protectedvirtual

Render the attribute and update the dimensions and color.

Member Data Documentation

DtQuad* makVrv::DtBaseQuadAttribute::myQuad

protected

DtDe& makVrv::DtBaseQuadAttribute::myDe

protected

float makVrv::DtBaseQuadAttribute::myX

protected

float makVrv::DtBaseQuadAttribute::myY

protected

float makVrv::DtBaseQuadAttribute::myZ

protected

float makVrv::DtBaseQuadAttribute::myW

protected

double makVrv::DtBaseQuadAttribute::myOffsetX

protected

double makVrv::DtBaseQuadAttribute::myOffsetY

protected

float makVrv::DtBaseQuadAttribute::myR

protected

float makVrv::DtBaseQuadAttribute::myG

protected

float makVrv::DtBaseQuadAttribute::myB

protected

float makVrv::DtBaseQuadAttribute::myA

protected

double makVrv::DtBaseQuadAttribute::mySizeX

protected

double makVrv::DtBaseQuadAttribute::mySizeY

protected

bool makVrv::DtBaseQuadAttribute::myVisible

protected

unsigned int makVrv::DtBaseQuadAttribute::myOverlay

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvOsg/DtBaseQuadAttribute.h