VR-Forces 4.3.1 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
makVrv::DtBoxFacadeInterface Class Reference

Contains DtBoxFacadeInterface class. More...

Inheritance diagram for makVrv::DtBoxFacadeInterface:
Inheritance graph
[legend]

Public Member Functions

 DtBoxFacadeInterface (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
 Constructor that will take an existing scene object agent.
 DtBoxFacadeInterface (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
 Will create a new scene object agent for the given model set and element id.
virtual ~DtBoxFacadeInterface ()
 DTOR.
virtual void addPoint (int index, const DtVector &)
 Overridden to make sure no more than 4 points are added.
virtual void setPoint (int iIndex, const DtVector &)
 Sets position box.
virtual void removePoint (int)
 Overriden for no-op. Boxes cannot remove points.
virtual void setPoints (const std::vector< DtVector > &, const DtVector &withOffset=DtVector::zero())
 Overriden to make sure there are exactly 4 points.
- Public Member Functions inherited from makVrv::DtAreaFacadeInterface
 DtAreaFacadeInterface (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
 Constructor that will take an existing scene object agent.
 DtAreaFacadeInterface (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
 Will create a new scene object agent for the given model set and element id.
virtual ~DtAreaFacadeInterface ()
 DTOR.
virtual void setModelDefinition (const std::string &)
 Sets the model definition for the model.
virtual void setColor (float r, float g, float b, float a)
 Sets the color for the area.
virtual void setOutsideColor (float r, float g, float b, float a)
 Sets the outside color (rim) if available.
virtual void setInsideColor (float r, float g, float b, float a)
 Sets inside color (fill) if available.
virtual void setLineWidth (int)
 Sets the width of the outside line. Default is 2.
virtual void setFill (bool)
 Sets whether or not to fill area. If fill style of line is specified, will override this flag.
virtual void setFillPattern (vrvTacticalGraphicUtilities::FillStyle)
 Sets the fill pattern for the area.
virtual void setSelected (bool)
 Sets the area to be selected.
virtual void setStipplePattern (int)
 Sets the pattern for the line portion of the area.
virtual void resetOrigin ()
 Once the origin is set it cannot be changed, unless this method is called first.
virtual void setOrigin (const DtVector &)
 Sets the origin of the area.
virtual const DtVectororigin () const
 Returns origin.
virtual void setUseDynamicOrigin (bool)
 Sets whether or not to use dynamic origins.
virtual void setSolid (bool)
 Sets whether or not this is a solid item.
virtual void setLockUpdates (bool)
 Sets whether or not to lock updates.
virtual bool updatesLocked () const
 Returns whether or not updates are locked.
virtual void setVisible (bool)
 Sets the object visible.
virtual void setPickable (bool)
 Sets pickable or not.
virtual const std::vector
< DtVector > & 
points () const
 Returns the points in this area.
virtual makVrv::DtUniqueID uniqueId () const
 Returns the unique id of the scene object agent.
virtual makVrv::DtElementID elementId () const
 Returns the element id of the scene object agent.
virtual int modelSet () const
 Returns the model set.
virtual void setScribed (bool)
 Sets whether or not line is scribed.
virtual DtSceneObjectAgent * sceneObjectAgent ()
 Returns the scene object agent associated with this facade.

Protected Attributes

DtBoxUpdaterAgent * myUpdater
- Protected Attributes inherited from makVrv::DtAreaFacadeInterface
DtPolygonModelAgent * myArea
DtAgentManagerInterfacemyAgentManagerInterface
DtSceneObjectAgent * mySceneObjectAgent
bool myOwnsSceneObjectAgent
float myOutsideColor [4]
float myInsideColor [4]
int myLineWidth
int myModelSet
bool myFill
std::vector< DtVectormyControlPoints
bool myOriginSet
DtVector myOrigin
bool myUpdatesLocked
bool mySelected
makVrv::DtElementID myElementId

Detailed Description

Contains DtBoxFacadeInterface class.

Facade for a 2D (overlay) box. All boxes must have 4 points defined. If the lengths or widths of the sides are not equal then the facade will compensate for the largest side. It will not, however, change the values in the listener. Those will remain the same.

The points are laid out as 0 = upper left, 1 = upper right, 2 = lower right, 3 = lower left.

Constructor & Destructor Documentation

makVrv::DtBoxFacadeInterface::DtBoxFacadeInterface ( DtAgentManagerInterface ,
DtSceneObjectAgent *  agent,
DtElementID  id,
int  modelSet 
)

Constructor that will take an existing scene object agent.

makVrv::DtBoxFacadeInterface::DtBoxFacadeInterface ( DtAgentManagerInterface ,
int  modelSet,
DtElementID  id,
bool  distribute = true 
)

Will create a new scene object agent for the given model set and element id.

virtual makVrv::DtBoxFacadeInterface::~DtBoxFacadeInterface ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtBoxFacadeInterface::addPoint ( int  index,
const DtVector  
)
virtual

Overridden to make sure no more than 4 points are added.

Note this routine will not enforce the box shape. It is up to the caller of this routine to make sure that the point(s) set conform to a box

Reimplemented from makVrv::DtAreaFacadeInterface.

virtual void makVrv::DtBoxFacadeInterface::setPoint ( int  iIndex,
const DtVector  
)
virtual

Sets position box.

If index is > 3 it is ignored. Note this routine will not enforce the box shape. It is up to the caller of this routine to make sure that the point(s) set conform to a box

Reimplemented from makVrv::DtAreaFacadeInterface.

virtual void makVrv::DtBoxFacadeInterface::removePoint ( int  )
virtual

Overriden for no-op. Boxes cannot remove points.

Reimplemented from makVrv::DtAreaFacadeInterface.

virtual void makVrv::DtBoxFacadeInterface::setPoints ( const std::vector< DtVector > &  ,
const DtVector withOffset = DtVector::zero() 
)
virtual

Overriden to make sure there are exactly 4 points.

Note this routine will not enforce the box shape. It is up to the caller of this routine to make sure that the point(s) set conform to a box. If withOffset is specified, the offset is added to the supplied points.

Reimplemented from makVrv::DtAreaFacadeInterface.

Member Data Documentation

DtBoxUpdaterAgent* makVrv::DtBoxFacadeInterface::myUpdater
protected

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

Document ID: Generated on Wed Jul 29 00:55:00 EDT 2015 from SVN revision 155257
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)