VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtBaseQuadAttribute Class Reference

Attribute that generates a colored quad. More...

Inheritance diagram for makVrv::DtBaseQuadAttribute:
Inheritance graph
[legend]

List of all members.

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 setVisible (bool visible)
 Set the attribute visible or hidden.
virtual bool visible () const
 Get the visibility of the attribute.
virtual DtQuadquad ()
 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.

Protected Member Functions

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

Protected Attributes

DtQuadmyQuad
DtDemyDe
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

Detailed Description

Attribute that generates a colored quad.

Note:
This class is intended for derivation or composition.

Constructor & Destructor Documentation

CTOR.

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::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 ( ) [protected, virtual]

Render the attribute and update the dimensions and color.


Member Data Documentation

unsigned int makVrv::DtBaseQuadAttribute::myOverlay [protected]

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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)