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

A single 2D quadrilateral. More...

List of all members.

Public Types

enum  FillType { Fill_Solid = 0, Fill_Stipple, Fill_Texture }

Public Member Functions

 DtQuad (DtQuadRenderer &renderer)
 CTOR.
 DtQuad (DtOverlayRenderer &renderer)
 CTOR.
 ~DtQuad ()
 DTOR.
void setPosition (float x, float y, float z, float w)
 Set the quad position.
void getPosition (float &x, float &y, float &z, float &w) const
 Get the quad position.
void setRotation (float angle)
 Set the quad's rotation.
void getRotation (float &angle) const
 Get the quad's rotation.
void setGroup (float order)
 Set the order group, where zero is not rendered, and higher groups are rendered on top of lower groups.
float group () const
 Get the order group.
void setColor (float r, float g, float b, float a)
 Set the quad color.
void getColor (float &r, float &g, float &b, float &a) const
 Get the color.
void getBounds (DtBoundingBox &bounds) const
 Get the quad size.
void setPoints (const float points[8])
 Set the quad's points explicitly.
void getPoints (float points[8])
 Fill points array with quad's vertices.
void setFillType (FillType type)
 Set the quad fill type.
FillType fillType () const
 Get the fall type.
void setFillParameter (unsigned int param, unsigned int fullStipplePattern[32]=0)
 Set the quad fill parameter.
void 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 textureParameter () const
 Set the texture parameter.

Protected Attributes

DtQuadProxymyProxy

Detailed Description

A single 2D quadrilateral.


Member Enumeration Documentation

Enumerator:
Fill_Solid 
Fill_Stipple 
Fill_Texture 

Constructor & Destructor Documentation

CTOR.

CTOR.

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::getBounds ( DtBoundingBox bounds) const

Get the quad size.

Return values:
returnsfalse if quad is using explicit points instead
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,...]

Set the quad fill type.

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

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.

Set the texture parameter.


Member Data Documentation


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)