VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes
makVrv::DtBaseQuadAttribute Class Reference

Attribute that generates a colored quad.

Note
This class is intended for derivation or composition.
Inheritance diagram for makVrv::DtBaseQuadAttribute:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtBaseQuadAttribute ()
 
 DtBaseQuadAttribute ()=delete
 
 DtBaseQuadAttribute (const DtBaseQuadAttribute &other)=delete
 
DtBaseQuadAttributeoperator= (const DtBaseQuadAttribute &other)=delete
 
virtual void setOffset (double x, double y)
 
virtual void setPosition (float x, float y, float z, float w)
 
virtual void getMinSize (double &xOut, double &yOut)
 
virtual void setSize (double x, double y)
 
virtual void setColor (float r, float g, float b, float a)
 
virtual void setShadowText (bool enabled)
 
virtual void setVisible (bool visible)
 
virtual bool visible () const
 
virtual void setLodOutAltitude (double lodOutAltitude) override
 
virtual double lodOutAltitude () const override
 
virtual void setIsLodOutAltitudeEnabled (bool isEnabled) override
 
virtual bool isLodOutAltitudeEnabled () const override
 
virtual DtQuadProxyquad ()
 
virtual void setOverlay (unsigned int overlayId)
 
virtual void setGroup (unsigned int group)
 
- Public Member Functions inherited from makVrv::DtAttribute
 DtAttribute ()
 
virtual ~DtAttribute ()
 
 DtAttribute (const DtAttribute &other)=delete
 
DtAttributeoperator= (const DtAttribute &other)=delete
 
virtual void setForegroundGroup (unsigned int group)
 
virtual void setBackgroundGroup (unsigned int group)
 

Protected Member Functions

 DtBaseQuadAttribute (DtDe &de)
 
virtual void updateQuad ()
 

Protected Attributes

DtQuadProxymyQuad
 
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
 
double myLodOutAltitude
 
bool myIsLodOutAltitudeEnabled
 

Private Attributes

friend DtBaseQuadAttributeCreator
 

Additional Inherited Members

- Public Attributes inherited from makVrv::DtAttribute
boost::signalslib::signal
< void(DtAttribute *, double,
double)> 
signal_sizeChanged
 

Constructor & Destructor Documentation

virtual makVrv::DtBaseQuadAttribute::~DtBaseQuadAttribute ( )
virtual

DTOR.

makVrv::DtBaseQuadAttribute::DtBaseQuadAttribute ( )
delete

Default Constructor not implemented.

makVrv::DtBaseQuadAttribute::DtBaseQuadAttribute ( const DtBaseQuadAttribute other)
delete

Copy Constructor not implemented - Copy not allowed.

makVrv::DtBaseQuadAttribute::DtBaseQuadAttribute ( DtDe de)
protected

Protected Constructor. Use DtBaseQuadAttributeCreator to create an instance of this class.

Member Function Documentation

DtBaseQuadAttribute& makVrv::DtBaseQuadAttribute::operator= ( const DtBaseQuadAttribute other)
delete

Assignment Operator not implemented - Assignment not allowed.

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. This function is not supported by this class and does nothing.

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 void makVrv::DtBaseQuadAttribute::setLodOutAltitude ( double  lodOutAltitude)
overridevirtual

Set the altitude, in meters, at which this attribute no longer appears. Only used if setIsLodOutAltitudeEnabled(true).

Implements makVrv::DtAttribute.

virtual double makVrv::DtBaseQuadAttribute::lodOutAltitude ( ) const
overridevirtual

Get the altitude, in meters, at which this attribute no longer appears.

Implements makVrv::DtAttribute.

virtual void makVrv::DtBaseQuadAttribute::setIsLodOutAltitudeEnabled ( bool  isEnabled)
overridevirtual

Set whether or not this attribute will use the LOD Out Altitude property.

Implements makVrv::DtAttribute.

virtual bool makVrv::DtBaseQuadAttribute::isLodOutAltitudeEnabled ( ) const
overridevirtual

Get whether or not this attribute will use the LOD Out Altitude property.

Implements makVrv::DtAttribute.

virtual DtQuadProxy* 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

friend makVrv::DtBaseQuadAttribute::DtBaseQuadAttributeCreator
private
DtQuadProxy* 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
double makVrv::DtBaseQuadAttribute::myLodOutAltitude
protected
bool makVrv::DtBaseQuadAttribute::myIsLodOutAltitudeEnabled
protected

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

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)