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

Contains Dt3DAreaFacade class. More...

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

Public Member Functions

 Dt3DAreaFacade (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
 Constructor that will take an existing scene object agent.
 Dt3DAreaFacade (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
 Will create a new scene object agent for the given model set and element id.
virtual ~Dt3DAreaFacade ()
 DTOR.
virtual void setLineWidth (int)
 Sets the up extent of the 3D line to represent width. Setting this will turn off line height.
virtual void setScribeWidth (float width)
 Sets the width of the scribe line in pixel space.
int scribeWidth () const
 Returns current scribe width.
virtual void setScribeAllPolygons (bool)
 Sets whether or not to only scribe the outline (and not the line edges).
virtual void setSolid (bool b)
 Sets whether or not this item is solid (filled)
virtual void setOutsideColor (float r, float g, float b, float a)
 No-op. Only inside color supported.
virtual void setInsideColor (float r, float g, float b, float a)
 Sets inside color (fill) if available.
virtual void setScribed (bool)
 Sets whether or not line is scribed.
virtual void setScribeColor (float r, float g, float b, float a)
 Sets the color of the scribe. By default it is based on outside color at 0% alpha.
virtual void setLineHeight (float)
 Sets the height of all lines in the area (up extent). Setting this will turn off line width.
virtual void setUpExtent (float)
virtual float upExtent () const
virtual void setDownExtent (float)
virtual float downExtent () const
virtual void setLeftExtent (float)
virtual float leftExtent () const
virtual void setRightExtent (float)
virtual float rightExtent () const
- Public Member Functions inherited from makVrv::Dt3DAreaFacadeBase
 Dt3DAreaFacadeBase (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
 Constructor that will take an existing scene object agent.
 Dt3DAreaFacadeBase (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
 Will create a new scene object agent for the given model set and element id.
virtual ~Dt3DAreaFacadeBase ()
 DTOR.
- Public Member Functions inherited from makVrv::DtAreaFacadeBase
 DtAreaFacadeBase (DtAgentManagerInterface &, DtSceneObjectAgent *agent, DtElementID id, int modelSet)
 Constructor that will take an existing scene object agent.
 DtAreaFacadeBase (DtAgentManagerInterface &, int modelSet, DtElementID id, bool distribute=true)
 Will create a new scene object agent for the given model set and element id.
virtual ~DtAreaFacadeBase ()
 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 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 setPoints (const std::vector< DtVector > &, const DtVector &withOffset=DtVector::zero())
 Sets the points for the area.
virtual void addPoint (int index, const DtVector &)
 Adds a point to the area. Returns the index of the newly added point. Index of -1 will append.
virtual void setSelected (bool)
 Sets the area to be selected.
virtual void removePoint (int)
 Removes a point from the area.
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 setPoint (int iIndex, const DtVector &)
 Sets position in the area.
virtual void setUseDynamicOrigin (bool)
 Sets whether or not to use dynamic origins.
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.
DtSceneObjectAgent * sceneObjectAgent () const
 Returns the scene object agent associated with this facade.
DtPolygonModelAgent * polygonModelAgent () const
 Returns the polygon model agent created for this class.

Protected Member Functions

void createAreaAgent ()
 Creates area agent used for facade. Called from constructor.

Protected Attributes

DtExtrudedPolygonModelAgent * myExtrudedArea
float myLineHeight
float myUpExtent
float myDownExtent
float myRightExtent
float myLeftExtent
bool myScribeColorSet
float myScribeWidth

Detailed Description

Contains Dt3DAreaFacade class.

Facade interface for constructing 3D area objects

Constructor & Destructor Documentation

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

Constructor that will take an existing scene object agent.

makVrv::Dt3DAreaFacade::Dt3DAreaFacade ( 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::Dt3DAreaFacade::~Dt3DAreaFacade ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrv::Dt3DAreaFacade::setLineWidth ( int  )
virtual

Sets the up extent of the 3D line to represent width. Setting this will turn off line height.

Reimplemented from makVrv::DtAreaFacadeBase.

virtual void makVrv::Dt3DAreaFacade::setScribeWidth ( float  width)
virtual

Sets the width of the scribe line in pixel space.

This will set a flag such that when the line width is changed this width is not, so, once set, you will need to continue to set to keep pace with line width.

Implements makVrv::Dt3DAreaFacadeBase.

int makVrv::Dt3DAreaFacade::scribeWidth ( ) const

Returns current scribe width.

virtual void makVrv::Dt3DAreaFacade::setScribeAllPolygons ( bool  )
virtual

Sets whether or not to only scribe the outline (and not the line edges).

Only valid if scribed is true. If set to true will scribe all point connections along the polygon. If false will only scribe the top and bottom of the polygon

Implements makVrv::Dt3DAreaFacadeBase.

virtual void makVrv::Dt3DAreaFacade::setSolid ( bool  b)
virtual

Sets whether or not this item is solid (filled)

Reimplemented from makVrv::DtAreaFacadeBase.

virtual void makVrv::Dt3DAreaFacade::setOutsideColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

No-op. Only inside color supported.

Reimplemented from makVrv::DtAreaFacadeBase.

virtual void makVrv::Dt3DAreaFacade::setInsideColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Sets inside color (fill) if available.

Reimplemented from makVrv::DtAreaFacadeBase.

virtual void makVrv::Dt3DAreaFacade::setScribed ( bool  )
virtual

Sets whether or not line is scribed.

You will need to scribe a line if you want the edges of the line to appear separate from the body of the object. If you do not scribe the object the edges will be difficult to differentiate from the rest of the model

Reimplemented from makVrv::DtAreaFacadeBase.

virtual void makVrv::Dt3DAreaFacade::setScribeColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Sets the color of the scribe. By default it is based on outside color at 0% alpha.

Implements makVrv::Dt3DAreaFacadeBase.

virtual void makVrv::Dt3DAreaFacade::setLineHeight ( float  )
virtual

Sets the height of all lines in the area (up extent). Setting this will turn off line width.

virtual void makVrv::Dt3DAreaFacade::setUpExtent ( float  )
virtual

Sets the values of the extents of the line. Extents of the line are different than the width or height in that in setting the width or height those are centered around the points. The extents work from the point and move in the direction of the extent in topographic space. For example, if you imagine a straight line, the up extent moves straight up from that line, the down extent straight down, left to the left and right to the right. As the line rotates and orients the extents orient and rotate with that line

Implements makVrv::Dt3DAreaFacadeBase.

virtual float makVrv::Dt3DAreaFacade::upExtent ( ) const
virtual
virtual void makVrv::Dt3DAreaFacade::setDownExtent ( float  )
virtual
virtual float makVrv::Dt3DAreaFacade::downExtent ( ) const
virtual
virtual void makVrv::Dt3DAreaFacade::setLeftExtent ( float  )
virtual
virtual float makVrv::Dt3DAreaFacade::leftExtent ( ) const
virtual
virtual void makVrv::Dt3DAreaFacade::setRightExtent ( float  )
virtual
virtual float makVrv::Dt3DAreaFacade::rightExtent ( ) const
virtual
void makVrv::Dt3DAreaFacade::createAreaAgent ( )
protected

Creates area agent used for facade. Called from constructor.

Member Data Documentation

DtExtrudedPolygonModelAgent* makVrv::Dt3DAreaFacade::myExtrudedArea
protected
float makVrv::Dt3DAreaFacade::myLineHeight
protected
float makVrv::Dt3DAreaFacade::myUpExtent
protected
float makVrv::Dt3DAreaFacade::myDownExtent
protected
float makVrv::Dt3DAreaFacade::myRightExtent
protected
float makVrv::Dt3DAreaFacade::myLeftExtent
protected
bool makVrv::Dt3DAreaFacade::myScribeColorSet
protected
float makVrv::Dt3DAreaFacade::myScribeWidth
protected

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

Document ID: Generated on Wed Jul 25 16:57:45 EDT 2018 from SVN revision 190790
Copyright © 2005-2018 VT MÄK. All Rights Reserved (www.mak.com)