VR-Forces Developer's Guide
 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::DtOverlayModel Class Referenceabstract
vrvCore

Base Overlay Model.

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

Public Member Functions

 DtOverlayModel (DtDe &de, DtUniqueID id)
 
virtual ~DtOverlayModel ()
 
 DtOverlayModel ()=delete
 
 DtOverlayModel (const DtOverlayModel &)=delete
 
DtOverlayModel & operator= (const DtOverlayModel &)=delete
 
 DtOverlayModel (const DtOverlayModel &&)=delete
 
DtOverlayModel & operator= (const DtOverlayModel &&other)=delete
 
virtual void setOrientation (const DtTaitBryan &orientation)
 
virtual void setColor (float r, float g, float b, float a)
 
virtual bool getColor (float &r, float &g, float &b, float &a) const
 
Model setters/getters (abstract)
virtual void setOrigin (const DtVector &position)
 
virtual DtVector origin () const
 
virtual void setScale (float scale)
 
virtual float scale () const
 
virtual void setVisible (bool isVisible)
 
virtual bool isVisible () const
 
virtual void setStipplePattern (unsigned int stipplePattern)
 
virtual unsigned int stipplePattern () const
 
virtual void setLineWidth (float)
 
virtual float lineWidth () const
 
virtual void setEventsEnabled (bool enabled)
 
virtual bool eventsEnabled () const
 
virtual void setGroup (int groupNum)
 
virtual int group () const
 
virtual void setFontFile (std::string fontFile)
 
virtual std::string fontFile () const
 
virtual void setFontPointSize (float pointSize)
 
virtual float fontPointSize () const
 
virtual void setFontColor (float r, float g, float b, float a)
 
virtual bool getFontColor (float &r, float &g, float &b, float &a) const
 
virtual void setPosition (int vtx, const DtVector &position) override
 
virtual void setOrientation (int vtx, const DtTaitBryan &orientation) override
 
virtual void setModelDefinition (const std::string &str) override
 
- Public Member Functions inherited from makVrv::DtModel
 DtModel (DtDe &de, DtUniqueID id)
 
virtual ~DtModel ()
 
DtModelInstance * createModelInstance (const std::string &modelDefName, bool realize=true)
 
virtual const std::string & modelDefinitionName ()
 
virtual void saveModelToFile (const std::string &filename)
 
virtual const std::string & className () const
 
virtual DtUniqueID uniqueId () const
 
unsigned int transformSize () const
 
virtual const DtVector & position (int vtx=0) const
 
virtual void removePosition (int vtx)
 
virtual void setPositionOffset (const DtVector &positionOffset)
 
virtual const DtVector & positionOffset () const
 
virtual void setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)
 
virtual const DtTaitBryan & orientation (int vtx=0) const
 
virtual void setOrientationOffset (const DtTaitBryan &orientationOffset)
 
virtual const DtTaitBryan & orientationOffset () const
 
virtual void enableColorBlending (bool b)
 
virtual void setBlendColor (float r, float g, float b, float a)
 
virtual void getBlendColor (float &r, float &g, float &b, float &a)
 
virtual bool colorBlendingEnabled () const
 
virtual void enableLighting (bool l)
 
virtual DtModelSetId modelSet () const
 
const DtVector & boundingBoxExtents () const
 
void getBoundingBoxExtents (double &x, double &y, double &z) const
 
const DtVector & boundingBoxCenter () const
 
virtual void getBoundingBoxCenter (double &x, double &y, double &z) const
 
virtual void getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
 
void setContributesToBound (bool trueOrFalse)
 
bool contributesToBound () const
 
DtDe & de ()
 
virtual void setModelInstance (DtModelInstance *modelInstance)
 
virtual void promoteBackgroundModelInstance (const DtModelDefinition &defintion)
 
virtual bool visible () const
 
DtUniqueID sceneObjectId () const
 
virtual void addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
 
virtual void addedToSceneObject (const DtUniqueID &sceneObj, DtModelSetId modelSet, int visualizerType)
 
virtual void setElementId (DtElementID id)
 
virtual void removedFromSceneObject ()
 
virtual void setSolid (bool isSolid)
 
virtual bool isProp ()
 
virtual void updateMinLastFrameDistance (float distance)
 
virtual void resetLastFrameDistance ()
 
virtual float minLastFrameDistance () const
 
virtual DtModelInstance * modelInstance ()
 
virtual const DtModelInstance * modelInstance () const
 
int visualizerType () const
 
virtual bool supportsMultithreadedLoad ()
 
virtual void backgroundLoad ()
 
virtual void foregroundLoad ()
 
virtual bool isActivelyBackgroundLoading ()
 
virtual DtLoaderHandle * getLoadQueueHandle ()
 

Protected Member Functions

virtual void needsUpdate ()
 
virtual void update ()
 
virtual void createGeometryIfNecessary ()=0
 
virtual void clearGeometry ()=0
 
virtual void updateVertices ()=0
 
virtual void updateColors ()=0
 
virtual void updateStipplePattern ()=0
 
virtual void updateLineWidth ()=0
 
virtual void updateEventsEnabled ()=0
 
virtual void updateGroup ()=0
 
virtual void updateLabels ()=0
 
virtual void slot_coordinateSystemChanged ()
 
virtual void addToScene (const DtUniqueID &sceneObjectId, DtModelSetId modelSet, int visualizerType) override
 
virtual void removeFromScene () override
 
virtual void setIsSupportModel (bool isSupport) override
 
- Protected Member Functions inherited from makVrv::DtModel
virtual void addToSceneAsProp (const DtUniqueID &sceneObjectId)
 
virtual void initializeModelInstance ()
 
void slot_modelInstanceChanged (DtModelInstance *instance)
 
virtual void waitAndClearLoadHandle ()
 
virtual void removedFromLoadQueue ()
 
virtual void setDoneBackgroundLoading ()
 
virtual void setActivelyBackgroundLoading ()
 

Protected Attributes

std::vector< DtVector > myControlPoints
 
std::vector< bool > myControlPointsSet
 
bool myNeedsUpdate
 
boost::signalslib::connection mySignalPostUpdateConnection
 
DtTaitBryan myOrientationTaitBryan
 
DtVector4< double > myColor
 
float myScale
 
float myLineWidth
 
bool myEventsEnabled
 
unsigned long long myUserData
 
bool myVisible
 
unsigned int myLineStipplePattern
 
int myGroup
 
int myOverlayId
 
int myGeometryInterfaceCount
 
int myLabelCount
 
DtVector myOrigin
 
DtSignalConnectionManager myConnections
 
DtCoordinateSystem * myCoordinateSystem
 
std::string myFontFile
 
float myFontPointSize
 
DtVector4< float > myFontColor
 
DtFontInterface * myFontInterface
 
DtAltitudeBasedConfigurationCollection myAltitudeBasedConfigurationCollection
 
DtOverlayGeometryManager & myOverlayGeometryManager
 
- Protected Attributes inherited from makVrv::DtModel
DtLoaderHandle * myInLoadQueueHandle
 
DtDe & myDe
 
const DtUniqueID myUniqueId
 
DtUniqueID myElementId
 
DtUniqueID myParentSceneObjectID
 
bool myColorBlendingEnabled
 
DtModelInstance * myBackgroundModelInstance
 
float myMinLastFrameDistance
 
TransformList myTransforms
 
DtModelInstance * myModelInstance
 
DtModelSetId myModelSet
 
int myVisualizerType
 
bool myContributesToBound
 
bool myIsPropFlag
 
float myBlendColor [4]
 
bool myVisibleFlag
 
DtVector myPositionOffset
 
DtTaitBryan myOrientationOffset
 
std::string myModelDefinitionName
 
bool myRequireModelInstance = true
 

Additional Inherited Members

- Public Attributes inherited from makVrv::DtModel
boost::signalslib::signal
< void(DtModel *)> 		signal_modelToBeDestroyed
 
boost::signalslib::signal
< void(DtModel *)> 		signal_modelChanged
 
boost::signalslib::signal
< bool(DtModel *, bool),
SlotReturnOR > 		signal_visibilityChangeRequested
 
boost::signalslib::signal
< void(DtModelInstance
*, DtModel *)> 		signal_modelInstanceCreated
 
boost::signalslib::signal
< void(DtModelInstance
*, DtModel *)> 		signal_modelInstanceToBeDestroyed
 
- Protected Types inherited from makVrv::DtModel
typedef std::vector
< ObjectTransform > 		TransformList
 
- Static Protected Attributes inherited from makVrv::DtModel
static bool theInittedState
 

Constructor & Destructor Documentation

makVrv::DtOverlayModel::DtOverlayModel ( DtDe &  de,
DtUniqueID  id 
)

CTOR.

virtual makVrv::DtOverlayModel::~DtOverlayModel ( )
virtual

DTOR.

makVrv::DtOverlayModel::DtOverlayModel ( )
delete

Default Constructor - not allowed.

makVrv::DtOverlayModel::DtOverlayModel ( const DtOverlayModel &  )
delete

Copy Constructor - not allowed.

makVrv::DtOverlayModel::DtOverlayModel ( const DtOverlayModel &&  )
delete

Move Constructor not allowed.

Member Function Documentation

DtOverlayModel& makVrv::DtOverlayModel::operator= ( const DtOverlayModel &  )
delete

Assignment Operator - not allowed.

DtOverlayModel& makVrv::DtOverlayModel::operator= ( const DtOverlayModel &&  other)
delete

Move assignment Operator - not allowed.

virtual void makVrv::DtOverlayModel::setOrigin ( const DtVector &  position)
virtual

Set/Get the global position of the security model.

virtual DtVector makVrv::DtOverlayModel::origin ( ) const
virtual

Set/Get the global position of the security model.

virtual void makVrv::DtOverlayModel::setOrientation ( const DtTaitBryan &  orientation)
virtual

Set the global orientation of the security model.

virtual void makVrv::DtOverlayModel::setScale ( float  scale)
virtual

Set/Get the numeric factor the security model is scaled by.

virtual float makVrv::DtOverlayModel::scale ( ) const
virtual

Set/Get the numeric factor the security model is scaled by.

virtual void makVrv::DtOverlayModel::setVisible ( bool  isVisible)
virtual

Set/Get whether the security model is visible.

Reimplemented from makVrv::DtModel.

virtual bool makVrv::DtOverlayModel::isVisible ( ) const
virtual

Set/Get whether the security model is visible.

virtual void makVrv::DtOverlayModel::setStipplePattern ( unsigned int  stipplePattern)
virtual

Set/Get the stipple pattern for the security model.

virtual unsigned int makVrv::DtOverlayModel::stipplePattern ( ) const
virtual

Set/Get the stipple pattern for the security model.

virtual void makVrv::DtOverlayModel::setLineWidth ( float  )
virtual

Set/Get the line width of the security model.

virtual float makVrv::DtOverlayModel::lineWidth ( ) const
virtual

Set/Get the line width of the security model.

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

Sets the line color of the security model.

Reimplemented from makVrv::DtModel.

virtual bool makVrv::DtOverlayModel::getColor ( float &  r,
float &  g,
float &  b,
float &  a 
) const
virtual
virtual void makVrv::DtOverlayModel::setEventsEnabled ( bool  enabled)
virtual

Set/Get whether to handle mouse events or not.

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

Set/Get whether to handle mouse events or not.

virtual void makVrv::DtOverlayModel::setGroup ( int  groupNum)
virtual

Sets the group this overlay will be drawn in. The higher the group number, the "closer" to the eyepoint this overlay will be drawn. Use this function to stack overlay objects in the particular order you want them displayed.

virtual int makVrv::DtOverlayModel::group ( ) const
virtual

Sets the group this overlay will be drawn in. The higher the group number, the "closer" to the eyepoint this overlay will be drawn. Use this function to stack overlay objects in the particular order you want them displayed.

virtual void makVrv::DtOverlayModel::setFontFile ( std::string  fontFile)
virtual

Set/Get the font file to use for the spider web.

virtual std::string makVrv::DtOverlayModel::fontFile ( ) const
virtual

Set/Get the font file to use for the spider web.

virtual void makVrv::DtOverlayModel::setFontPointSize ( float  pointSize)
virtual

Set/Get the font point size for the spider web.

virtual float makVrv::DtOverlayModel::fontPointSize ( ) const
virtual

Set/Get the font point size for the spider web.

virtual void makVrv::DtOverlayModel::setFontColor ( float  r,
float  g,
float  b,
float  a 
)
virtual

Set/Get the font color for the spider web.

virtual bool makVrv::DtOverlayModel::getFontColor ( float &  r,
float &  g,
float &  b,
float &  a 
) const
virtual

Set/Get the font color for the spider web.

virtual void makVrv::DtOverlayModel::setPosition ( int  vtx,
const DtVector &  position 
)
overridevirtual

Set the position of a vertex in the security model.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOverlayModel::setOrientation ( int  vtx,
const DtTaitBryan &  orientation 
)
overridevirtual

Set the orientation of the security model This function only does something if vtx equals 0.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOverlayModel::setModelDefinition ( const std::string &  str)
overridevirtual

Sets the model definition on the model instance.

Reimplemented from makVrv::DtModel.

virtual void makVrv::DtOverlayModel::addToScene ( const DtUniqueID &  sceneObjectId,
DtModelSetId  modelSet,
int  visualizerType 
)
overrideprotectedvirtual

Attaches the model to the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtOverlayModel::removeFromScene ( )
overrideprotectedvirtual

Detaches the model from the scene.

Implements makVrv::DtModel.

virtual void makVrv::DtOverlayModel::setIsSupportModel ( bool  isSupport)
overrideprotectedvirtual

Set whether the model is part of the support group (whether or not other scene objects can ground clamp to this model)

Implements makVrv::DtModel.

virtual void makVrv::DtOverlayModel::needsUpdate ( )
protectedvirtual

Sets flag so the object is updated in the next update pass.

virtual void makVrv::DtOverlayModel::update ( )
protectedvirtual

Called on tick.

virtual void makVrv::DtOverlayModel::createGeometryIfNecessary ( )
protectedpure virtual

Create according to current state.

Implemented in makVrv::DtOverlayLinearModel.

virtual void makVrv::DtOverlayModel::clearGeometry ( )
protectedpure virtual

Delete the DtSegmentedLines.

Implemented in makVrv::DtOverlayLinearModel.

virtual void makVrv::DtOverlayModel::updateVertices ( )
protectedpure virtual

Update the vertex locations.

Implemented in makVrv::DtOverlayLinearModel.

virtual void makVrv::DtOverlayModel::updateColors ( )
protectedpure virtual

Update methods, derived classes instantiate.

Implemented in makVrv::DtOverlayLinearModel.

virtual void makVrv::DtOverlayModel::updateStipplePattern ( )
protectedpure virtual

Implemented in makVrv::DtOverlayLinearModel.

virtual void makVrv::DtOverlayModel::updateLineWidth ( )
protectedpure virtual

Implemented in makVrv::DtOverlayLinearModel.

virtual void makVrv::DtOverlayModel::updateEventsEnabled ( )
protectedpure virtual

Implemented in makVrv::DtOverlayLinearModel.

virtual void makVrv::DtOverlayModel::updateGroup ( )
protectedpure virtual

Updates the interface and label groups.

Implemented in makVrv::DtOverlayLinearModel.

virtual void makVrv::DtOverlayModel::updateLabels ( )
protectedpure virtual

Updates the font, font color and altitude specific font for labels These should not change regularly.

Implemented in makVrv::DtOverlayLinearModel.

virtual void makVrv::DtOverlayModel::slot_coordinateSystemChanged ( )
protectedvirtual

Slot for when the coordinate system changes.

Member Data Documentation

std::vector<DtVector> makVrv::DtOverlayModel::myControlPoints
protected
std::vector<bool> makVrv::DtOverlayModel::myControlPointsSet
protected
bool makVrv::DtOverlayModel::myNeedsUpdate
protected
boost::signalslib::connection makVrv::DtOverlayModel::mySignalPostUpdateConnection
protected
DtTaitBryan makVrv::DtOverlayModel::myOrientationTaitBryan
protected
DtVector4<double> makVrv::DtOverlayModel::myColor
protected
float makVrv::DtOverlayModel::myScale
protected
float makVrv::DtOverlayModel::myLineWidth
protected
bool makVrv::DtOverlayModel::myEventsEnabled
protected
unsigned long long makVrv::DtOverlayModel::myUserData
protected
bool makVrv::DtOverlayModel::myVisible
protected
unsigned int makVrv::DtOverlayModel::myLineStipplePattern
protected
int makVrv::DtOverlayModel::myGroup
protected
int makVrv::DtOverlayModel::myOverlayId
protected
int makVrv::DtOverlayModel::myGeometryInterfaceCount
protected
int makVrv::DtOverlayModel::myLabelCount
protected
DtVector makVrv::DtOverlayModel::myOrigin
protected
DtSignalConnectionManager makVrv::DtOverlayModel::myConnections
protected
DtCoordinateSystem* makVrv::DtOverlayModel::myCoordinateSystem
protected
std::string makVrv::DtOverlayModel::myFontFile
protected
float makVrv::DtOverlayModel::myFontPointSize
protected
DtVector4<float> makVrv::DtOverlayModel::myFontColor
protected
DtFontInterface* makVrv::DtOverlayModel::myFontInterface
protected
DtAltitudeBasedConfigurationCollection makVrv::DtOverlayModel::myAltitudeBasedConfigurationCollection
protected
DtOverlayGeometryManager& makVrv::DtOverlayModel::myOverlayGeometryManager
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)