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

A single 2D quadrilateral. None of this class's member functions are virtual because:

Public Types

enum  FillType { Fill_Solid = 0, Fill_Stipple, Fill_Texture }
 

Public Member Functions

 DtQuad (DtQuadRenderer &renderer)
 
 DtQuad (DtOverlayRenderer &renderer)
 
 ~DtQuad ()
 
void setPosition (float x, float y, float z, float w)
 
void getPosition (float &x, float &y, float &z, float &w) const
 
void setRotation (float angle)
 
void getRotation (float &angle) const
 
void setGroup (float order)
 
float group () const
 
void setColor (float r, float g, float b, float a)
 
void getColor (float &r, float &g, float &b, float &a) const
 
void setBounds (const DtBoundingBox &bounds)
 
void getBounds (DtBoundingBox &bounds) const
 
void setPoints (const float points[8])
 
void getPoints (float points[8])
 
void setPointsByMinimumAltitude (const float points[8], double cameraAltitude)
 
void setIsForcedPointsByAltitudeEnabled (bool isEnabled)
 
void setAltitudeForForcedPoints (double minimumAltitudeForUse)
 
void clearAltitudeSpecificConfigurations ()
 
void setFillType (FillType type)
 
FillType fillType () const
 
void setFillParameter (unsigned int param, unsigned int fullStipplePattern[32]=0)
 
void setTextureParameter (DtOverlayResourceProvider::NativeResourceHandle texture, float left=0.0f, float right=1.0f, float bottom=0.0f, float top=1.0f)
 
DtOverlayResourceProvider::NativeResourceHandle textureParameter () const
 
void setLodOutAltitude (double lodOutAltitude)
 
void setIsLodOutAltitudeEnabled (bool isLodOutAltitudeEnabled)
 

Protected Attributes

DtQuadProxymyProxy
 

Member Enumeration Documentation

Enumerator
Fill_Solid 
Fill_Stipple 
Fill_Texture 

Constructor & Destructor Documentation

makVrv::DtQuad::DtQuad ( DtQuadRenderer renderer)

CTOR.

makVrv::DtQuad::DtQuad ( DtOverlayRenderer renderer)

CTOR.

makVrv::DtQuad::~DtQuad ( )

DTOR.

Member Function Documentation

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

Set the quad position.

void makVrv::DtQuad::getPosition ( float &  x,
float &  y,
float &  z,
float &  w 
) const

Get the quad position.

void makVrv::DtQuad::setRotation ( float  angle)

Set the quad's rotation.

void makVrv::DtQuad::getRotation ( float &  angle) const

Get the quad's rotation.

void makVrv::DtQuad::setGroup ( float  order)

Set the order group, where zero is not rendered, and higher groups are rendered on top of lower groups.

float makVrv::DtQuad::group ( ) const

Get the order group.

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

Set the quad color.

void makVrv::DtQuad::getColor ( float &  r,
float &  g,
float &  b,
float &  a 
) const

Get the color.

void makVrv::DtQuad::setBounds ( const DtBoundingBox bounds)

Set the quad size.

void makVrv::DtQuad::getBounds ( DtBoundingBox bounds) const

Get the quad size.

void makVrv::DtQuad::setPoints ( const float  points[8])

Set the quad's points explicitly.

Parameters
pointsarray of 2d points arranged like [x0,y0,x1,y1,...]
void makVrv::DtQuad::getPoints ( float  points[8])

Fill points array with quad's vertices.

Parameters
pointsarray of 2d points arranged like [x0,y0,x1,y1,...]
void makVrv::DtQuad::setPointsByMinimumAltitude ( const float  points[8],
double  cameraAltitude 
)

Set the quad's points explicitly, based on the current altitude of the observer rendering the quad.

void makVrv::DtQuad::setIsForcedPointsByAltitudeEnabled ( bool  isEnabled)

Set whether or not a particular set of points are used, regardless of altitude. This only matters if altitude-specific sets of points are used. The sets of points used are provided by the altitude-specific configuration corresponding to the altitude provided using: setAltitudeForForcedPoints(...)

void makVrv::DtQuad::setAltitudeForForcedPoints ( double  minimumAltitudeForUse)

Set the altitude, in meters, to use when determining the forced set of points. This is only used if setIsForcedPointsByAltitudeEnabled(true).

void makVrv::DtQuad::clearAltitudeSpecificConfigurations ( )

Clear all altitude-specific configurations.

void makVrv::DtQuad::setFillType ( FillType  type)

Set the quad fill type. Calling fill type resets the fill parameter, thus the fill parameter must be reset after calling setFillType.

FillType makVrv::DtQuad::fillType ( ) const

Get the fall type.

void makVrv::DtQuad::setFillParameter ( unsigned int  param,
unsigned int  fullStipplePattern[32] = 0 
)

Set the quad fill parameter. In Texture mode the parameter is the texture index. If the full stippledPattern (aka a full 32x32 bit array) the initial param is ignored.

void makVrv::DtQuad::setTextureParameter ( DtOverlayResourceProvider::NativeResourceHandle  texture,
float  left = 0.0f,
float  right = 1.0f,
float  bottom = 0.0f,
float  top = 1.0f 
)

Set the texture parameter.

DtOverlayResourceProvider::NativeResourceHandle makVrv::DtQuad::textureParameter ( ) const

Set the texture parameter.

void makVrv::DtQuad::setLodOutAltitude ( double  lodOutAltitude)

Set the minimum MSL altitude, in meters, at which the quad will no longer appear.

void makVrv::DtQuad::setIsLodOutAltitudeEnabled ( bool  isLodOutAltitudeEnabled)

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

Member Data Documentation

DtQuadProxy* makVrv::DtQuad::myProxy
protected

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

Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)