makVrv::DtQuadProxyInterface Class Reference

A single 2D quadrilateral.

Inheritance diagram for makVrv::DtQuadProxyInterface:

Public Types
enum	FillType { Fill_Solid = 0, Fill_Stipple, Fill_Texture, Fill_Repeating_Texture }

Public Member Functions
	DtQuadProxyInterface ()
virtual	~DtQuadProxyInterface ()
virtual void	set3DPosition (int index, float x, float y, float z, float w)=0
virtual void	set3DPosition (float x, float y, float z, float w=0)=0
virtual void	get3DPosition (float &x, float &y, float &z, float &w) const =0
virtual void	set2DRotation (float angle)=0
virtual void	get2DRotation (float &angle) const =0
virtual void	setIsRotationInScreenSpace (bool isRotationInScreenSpace)=0
virtual bool	isRotationInScreenSpace () const =0
virtual void	setMaximumWorldHeight (double worldHeightInMeters)=0
virtual double	maximumWorldHeight () const =0
virtual void	setMaximumWorldWidth (double worldWidthInMeters)=0
virtual double	maximumWorldWidth () const =0
virtual void	setPoints (const float points[8])=0
virtual void	getPoints (float points[8]) const =0
virtual void	setBounds (const DtBoundingBox &box)=0
virtual void	getBounds (DtBoundingBox &box) const =0
virtual void	setPointsByMinimumAltitude (const float points[8], double cameraAltitude)=0
virtual void	setIsForcedPointsByAltitudeEnabled (bool isEnabled)=0
virtual void	setAltitudeForForcedPoints (double minimumAltitudeForUse)=0
virtual void	clearAltitudeSpecificConfigurations ()=0
virtual void	setGroup (float order)=0
virtual float	group () const =0
virtual void	setColor (float r, float g, float b, float a)=0
virtual void	getColor (float &r, float &g, float &b, float &a) const =0
virtual void	setBounds (const float bounds[4])=0
virtual void	getBounds (float bounds[4]) const =0
virtual void	setFillType (FillType type)=0
virtual FillType	fillType () const =0
virtual void	setFillParameter (unsigned int fullStipplePattern[32]=0)=0
virtual void	setTextureParameters (DtTextureInterface *textureHandle, float left=0.0f, float right=1.0f, float bottom=0.0f, float top=1.0f)=0
virtual DtTextureInterface *	findTextureHandle () const =0
virtual void	setLodOutAltitude (double lodOutAltitude)=0
virtual double	lodOutAltitude () const =0
virtual void	setIsLodOutAltitudeEnabled (bool isLodOutAltitudeEnabled)=0
virtual bool	isLodOutAltitudeEnabled () const =0

Member Enumeration Documentation

enum makVrv::DtQuadProxyInterface::FillType

Enumerator
Fill_Solid
Fill_Stipple
Fill_Texture
Fill_Repeating_Texture

Constructor & Destructor Documentation

makVrv::DtQuadProxyInterface::DtQuadProxyInterface

(

)

CTOR.

virtual makVrv::DtQuadProxyInterface::~DtQuadProxyInterface ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtQuadProxyInterface::set3DPosition ( int  index, float  x, float  y, float  z, float  w  )

pure virtual

Set the position at the given index of the quad (points 0 - 3)

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::set3DPosition ( float  x, float  y, float  z, float  w = 0  )

pure virtual

Set the quad position.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::get3DPosition ( float &  x, float &  y, float &  z, float &  w  ) const

pure virtual

Get the quad position.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::set2DRotation ( float  angle )

pure virtual

Set the quad's rotation.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::get2DRotation ( float &  angle ) const

pure virtual

Get the quad's rotation.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setIsRotationInScreenSpace ( bool  isRotationInScreenSpace )

pure virtual

Set whether or not the rotation of the quad object is in screen space. If rotation is in screen space, a 0 degrees rotation means the top of the user's computer monitor. If rotation is not in screen space, it is in world space with a 0 degrees rotation meaning the direction of True North. Default is true.

Implemented in makVrv::DtQuadProxy.

virtual bool makVrv::DtQuadProxyInterface::isRotationInScreenSpace ( ) const

pure virtual

Get whether or not the rotation of the text object is in screen space.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setMaximumWorldHeight ( double  worldHeightInMeters )

pure virtual

Set the maximum world-space height for the this proxy, in meters. Once the quad proxy exceeds the maximum world-space height the quad will not be rendered. To disable this mechanism altogether (for height), set this property to -1.0. By default, this property is set to -1.0 (and as a result this mechanism is unused by default).

Implemented in makVrv::DtQuadProxy.

virtual double makVrv::DtQuadProxyInterface::maximumWorldHeight ( ) const

pure virtual

Returns the maximum world-space height for the this proxy, in meters.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setMaximumWorldWidth ( double  worldWidthInMeters )

pure virtual

Set the maximum world-space width for the this proxy, in meters. Once the quad proxy exceeds the maximum world-space width the quad will not be rendered. To disable this mechanism altogether (for width), set this property to -1.0. By default, this property is set to -1.0 (and as a result this mechanism is unused by default).

Implemented in makVrv::DtQuadProxy.

virtual double makVrv::DtQuadProxyInterface::maximumWorldWidth ( ) const

pure virtual

Returns the maximum world-space width for the this proxy, in meters.

Implemented in makVrv::DtQuadProxy.

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

pure virtual

Set the quad's points explicitly.

Parameters

points

array of 2d points arranged like [x0,y0,x1,y1,...]

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::getPoints ( float  points[8] ) const

pure virtual

Fill points array with quad's vertices.

Parameters

points

array of 2d points arranged like [x0,y0,x1,y1,...]

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setBounds ( const DtBoundingBox &  box )

pure virtual

Set the bounding box to use.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::getBounds ( DtBoundingBox &  box ) const

pure virtual

Get the bounding box.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setPointsByMinimumAltitude ( const float  points[8], double  cameraAltitude  )

pure virtual

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

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setIsForcedPointsByAltitudeEnabled ( bool  isEnabled )

pure virtual

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(...)

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setAltitudeForForcedPoints ( double  minimumAltitudeForUse )

pure virtual

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

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::clearAltitudeSpecificConfigurations ( )

pure virtual

Clear all altitude-specific configurations.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setGroup ( float  order )

pure virtual

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

Implemented in makVrv::DtQuadProxy.

virtual float makVrv::DtQuadProxyInterface::group ( ) const

pure virtual

Get the order group.

Implemented in makVrv::DtQuadProxy.

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

pure virtual

Set the quad color.

Implemented in makVrv::DtQuadProxy.

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

pure virtual

Get the color.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setBounds ( const float  bounds[4] )

pure virtual

Set the quad size.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::getBounds ( float  bounds[4] ) const

pure virtual

Get the quad size.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setFillType ( FillType  type )

pure virtual

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

Implemented in makVrv::DtQuadProxy.

virtual FillType makVrv::DtQuadProxyInterface::fillType ( ) const

pure virtual

Get the fall type.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setFillParameter ( unsigned int  fullStipplePattern[32] = 0 )

pure virtual

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.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setTextureParameters ( DtTextureInterface *  textureHandle, float  left = 0.0f, float  right = 1.0f, float  bottom = 0.0f, float  top = 1.0f  )

pure virtual

Set the texture parameter.

Implemented in makVrv::DtQuadProxy.

virtual DtTextureInterface* makVrv::DtQuadProxyInterface::findTextureHandle ( ) const

pure virtual

Set the texture parameter.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setLodOutAltitude ( double  lodOutAltitude )

pure virtual

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

Implemented in makVrv::DtQuadProxy.

virtual double makVrv::DtQuadProxyInterface::lodOutAltitude ( ) const

pure virtual

Get the minimum altitude, in meters, at which this quad will no longer render.

Implemented in makVrv::DtQuadProxy.

virtual void makVrv::DtQuadProxyInterface::setIsLodOutAltitudeEnabled ( bool  isLodOutAltitudeEnabled )

pure virtual

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

Implemented in makVrv::DtQuadProxy.

virtual bool makVrv::DtQuadProxyInterface::isLodOutAltitudeEnabled ( ) const

pure virtual

Get whether or not to use the LOD Out Altitude property.

Implemented in makVrv::DtQuadProxy.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtQuadProxyInterface.h