VR-Vantage API Documentation
List of all members | Public Member Functions | Protected Attributes
makVrv::DtSprite Class Reference

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

Public Member Functions

 DtSprite (DtOverlayRenderer &renderer, DtWidgetPicker &picker)
 CTOR.
DtSpriteclone (DtOverlayRenderer &renderer, DtWidgetPicker &picker) const
 Create a clone, of the sprite, potentially on a new layer.
 ~DtSprite ()
 DTOR.
void setEventsEnabled (bool enabled, unsigned long long userData=0)
 Set whether the sprite has widget events.
bool eventsEnabled () const
 Get whether events are already enabled.
void setPosition (float x, float y, float z, float w=0)
 Set the quad position.
void setPoints (const float points[8])
 Set the quad corners.
void setRotation (float angle)
 Set the quad rotation.
void setFillType (DtQuad::FillType type)
 Set the fill type.
void setTextureParameter (DtOverlayResourceProvider::NativeResourceHandle texture, float left=0.0f, float right=1.0f, float bottom=0.0f, float top=1.0f)
 Set the quads texture parameters.
DtOverlayResourceProvider::NativeResourceHandle textureParameter () const
 Get the quad texture parameter.
void setColor (float r, float g, float b, float a)
 Set the quad color.
void setGroup (unsigned int group)
 Set the group of the sprite.
unsigned int group () const
 Get the group of the sprite.
const DtQuadquad () const
 get the quad
DtPickableQuadfindWidget ()
 Attempt to find the widget. If events are disabled there is no widget.
const DtPickableQuadfindWidget () const

Protected Attributes

DtWidgetPickermyPicker
DtQuadmyQuad
DtPickableQuadmyWidget

Detailed Description

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

Constructor & Destructor Documentation

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

CTOR.

makVrv::DtSprite::~DtSprite ( )

DTOR.

Member Function Documentation

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

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

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

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

bool makVrv::DtSprite::eventsEnabled ( ) const

Get whether events are already enabled.

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

Set the quad position.

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

Set the quad corners.

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

Set the quad rotation.

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

Set the fill type.

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

Set the quads texture parameters.

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

Get the quad texture parameter.

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

Set the quad color.

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

Set the group of the sprite.

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

Get the group of the sprite.

const DtQuad& makVrv::DtSprite::quad ( ) const

get the quad

DtPickableQuad* makVrv::DtSprite::findWidget ( )

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

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

Member Data Documentation

DtWidgetPicker& makVrv::DtSprite::myPicker
protected
DtQuad* makVrv::DtSprite::myQuad
protected
DtPickableQuad* makVrv::DtSprite::myWidget
protected

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


Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)