A synchronized Quad and Widget for a interactive visible 2D graphic.

Public Member Functions
	DtSprite (DtOverlayRenderer &renderer, DtWidgetPicker &picker)

DtSprite *	clone (DtOverlayRenderer &renderer, DtWidgetPicker &picker) const

virtual	~DtSprite ()

	DtSprite (const DtSprite &other)=delete

DtSprite &	operator= (const DtSprite &other)=delete

virtual void	setEventsEnabled (bool enabled, unsigned long long userData=0)

virtual bool	eventsEnabled () const

virtual void	setPosition (float x, float y, float z, float w=0)

virtual void	setPoints (const float points[8])

virtual void	setPointsByMinimumAltitude (const float points[8], double minimumAltitude)

virtual void	setIsForcedPointsByAltitudeEnabled (bool isEnabled)

virtual void	setAltitudeForForcedPoints (double altitude)

virtual void	clearAltitudeSpecificConfigurations ()

virtual void	setRotation (float angle)

void	setIsRotationInScreenSpace (bool isRotationInScreenSpace)

virtual void	setLodOutAltitude (double lodOutAltitude)

virtual void	setIsLodOutAltitudeEnabled (bool isLodOutAltitudeEnabled)

virtual void	setMaximumWorldHeight (double worldHeightInMeters)

virtual void	setMaximumWorldWidth (double worldWidthInMeters)

virtual void	setFillType (DtQuadProxyInterface::FillType type)

virtual void	setTextureParameter (DtTextureInterface *textureHandle, float left=0.0f, float right=1.0f, float bottom=0.0f, float top=1.0f)

DtTextureInterface *	textureParameter () const

virtual void	setColor (float r, float g, float b, float a)

virtual void	setGroup (unsigned int group)

virtual unsigned int	group () const

virtual const DtQuadProxy &	quad () const

virtual DtPickableQuad *	findWidget ()

virtual const DtPickableQuad *	findWidget () const

Protected Attributes
DtWidgetPicker &	myPicker

DtQuadProxy *	myQuad

DtPickableQuad *	myWidget

Constructor & Destructor Documentation

makVrv::DtSprite::DtSprite	(	DtOverlayRenderer &	renderer,
		DtWidgetPicker &	picker
	)

CTOR.

virtual makVrv::DtSprite::~DtSprite ( )

virtual

DTOR.

makVrv::DtSprite::DtSprite ( const DtSprite & other )

delete

Copy Constructor not implemented - Copy not allowed.

Member Function Documentation

DtSprite* makVrv::DtSprite::clone	(	DtOverlayRenderer &	renderer,
		DtWidgetPicker &	picker
	)		const

Create a clone, of the sprite, potentially on a new layer.

DtSprite& makVrv::DtSprite::operator= ( const DtSprite & other )

delete

Assignment Operator not implemented - Assignment not allowed.

virtual void makVrv::DtSprite::setEventsEnabled	(	bool	enabled,
		unsigned long long	userData = `0`
	)

virtual

Set whether the sprite has widget events. Disabling events disconnects all of the PickableWidget signals The user data is set when enabling the events, to change only the user data make multiple calls with enabled=true.

virtual bool makVrv::DtSprite::eventsEnabled ( ) const

virtual

Get whether events are already enabled.

virtual void makVrv::DtSprite::setPosition	(	float	x,
		float	y,
		float	z,
		float	w = `0`
	)

virtual

Set the quad position.

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

virtual

Set the quad corners.

virtual void makVrv::DtSprite::setPointsByMinimumAltitude	(	const float	points[8],
		double	minimumAltitude
	)

virtual

Set the quad corners based on the current altitude of the observer rendering the sprite.

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

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

virtual void makVrv::DtSprite::setAltitudeForForcedPoints ( double altitude )

virtual

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

virtual void makVrv::DtSprite::clearAltitudeSpecificConfigurations ( )

virtual

Clear all altitude-specific configurations.

virtual void makVrv::DtSprite::setRotation ( float angle )

virtual

Set the quad rotation.

void makVrv::DtSprite::setIsRotationInScreenSpace ( bool isRotationInScreenSpace )

Set whether or not the rotation of the sprite 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.

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

virtual

Set the minimum altitude, in meters, at which this quad will no longer render. Only used if setIsLodOutAltitudeEnabled(true). Default is the maximum value a double can hold.

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

virtual

Set whether or not to use the LOD Out Altitude property. Default is true.

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

virtual

Set the maximum world-space height for the this sprite, in meters. Once the sprite exceeds the maximum world-space height the sprite will not be rendered. To disable this mechanism altogether, 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).

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

virtual

Set the maximum world-space width for the this sprite, in meters. Once the sprite exceeds the maximum world-space width the sprite will not be rendered. To disable this mechanism altogether, 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).

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

virtual

Set the fill type.

virtual void makVrv::DtSprite::setTextureParameter	(	DtTextureInterface *	textureHandle,
		float	left = `0.0f`,
		float	right = `1.0f`,
		float	bottom = `0.0f`,
		float	top = `1.0f`
	)

virtual

Set the quads texture parameters.

DtTextureInterface* makVrv::DtSprite::textureParameter ( ) const

Get the quad texture parameter.

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

virtual

Set the quad color.

virtual void makVrv::DtSprite::setGroup ( unsigned int group )

virtual

Set the group of the sprite.

virtual unsigned int makVrv::DtSprite::group ( ) const

virtual

Get the group of the sprite.

virtual const DtQuadProxy& makVrv::DtSprite::quad ( ) const

virtual

get the quad

virtual DtPickableQuad* makVrv::DtSprite::findWidget ( )

virtual

Attempt to find the widget. If events are disabled there is no widget.

virtual const DtPickableQuad* makVrv::DtSprite::findWidget ( ) const

virtual

Member Data Documentation

DtWidgetPicker& makVrv::DtSprite::myPicker

protected

DtQuadProxy* makVrv::DtSprite::myQuad

protected

DtPickableQuad* makVrv::DtSprite::myWidget

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvGraphics/DtSprite.h

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation