VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::exampleSymbolFacade3::DtSymbolFacade Class Reference

Encapsulates the creation/management of agents used to display a symbol. More...

Public Member Functions

 DtSymbolFacade (makVrv::DtAgentManagerInterface &sceneInterface, makVrv::DtElementID id)
 CTOR Creates a symbol facade for the 2D model set.
virtual ~DtSymbolFacade ()
 Virtual DTOR.
Symbol Facade Parameter Accessors
virtual makVrv::DtElementID elementId () const
 Get the element id for the entity facade.
virtual
makVrv::DtWidgetLabelAgent & 
widgetLabelAgent ()
 Returns the widget label for the facade.
virtual void setPosition (const DtVector &pos)
 Set the label's position.
virtual void setRotation (float angleInDegrees)
 Set the label's rotation.

Static Public Member Functions

static
makVrv::DtElementEntry::ElementType 
elementType ()
 Returns the unique element type for DtSymbolFacades.

Protected Member Functions

void initialize ()

Protected Attributes

makVrv::DtElementID myElementId
makVrv::DtSceneObjectAgent * mySceneObjectAgent
makVrv::DtProjectedWidgetModelAgent * myProjectedWidgetModelAgent
makVrv::DtWidgetLabelAgent * myWidgetLabelAgent

Detailed Description

Encapsulates the creation/management of agents used to display a symbol.

The Facade design pattern provides a unified interface for controlling the agents required to render a symbol. Using a facade makes using symbols easier by internally managing creation, deletion, and updating of the component model agents. Builds on the previous example by adding a method for rotating the symbol to a given angle.

Constructor & Destructor Documentation

makVrv::exampleSymbolFacade3::DtSymbolFacade::DtSymbolFacade ( makVrv::DtAgentManagerInterface sceneInterface,
makVrv::DtElementID  id 
)

CTOR Creates a symbol facade for the 2D model set.

virtual makVrv::exampleSymbolFacade3::DtSymbolFacade::~DtSymbolFacade ( )
virtual

Virtual DTOR.

Member Function Documentation

virtual makVrv::DtElementID makVrv::exampleSymbolFacade3::DtSymbolFacade::elementId ( ) const
virtual

Get the element id for the entity facade.

virtual makVrv::DtWidgetLabelAgent& makVrv::exampleSymbolFacade3::DtSymbolFacade::widgetLabelAgent ( )
virtual

Returns the widget label for the facade.

virtual void makVrv::exampleSymbolFacade3::DtSymbolFacade::setPosition ( const DtVector pos)
virtual

Set the label's position.

virtual void makVrv::exampleSymbolFacade3::DtSymbolFacade::setRotation ( float  angleInDegrees)
virtual

Set the label's rotation.

static makVrv::DtElementEntry::ElementType makVrv::exampleSymbolFacade3::DtSymbolFacade::elementType ( )
static

Returns the unique element type for DtSymbolFacades.

void makVrv::exampleSymbolFacade3::DtSymbolFacade::initialize ( )
protected

Member Data Documentation

makVrv::DtElementID makVrv::exampleSymbolFacade3::DtSymbolFacade::myElementId
protected
makVrv::DtSceneObjectAgent* makVrv::exampleSymbolFacade3::DtSymbolFacade::mySceneObjectAgent
protected
makVrv::DtProjectedWidgetModelAgent* makVrv::exampleSymbolFacade3::DtSymbolFacade::myProjectedWidgetModelAgent
protected
makVrv::DtWidgetLabelAgent* makVrv::exampleSymbolFacade3::DtSymbolFacade::myWidgetLabelAgent
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)