VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
makVrv::DtRectangularPyramidModel Class Referenceabstract

Distributed model for visualizing synthetic aperture sensors. More...

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

Public Member Functions

 DtRectangularPyramidModel (makVrv::DtDe &de, makVrv::DtUniqueID id)
 CTOR. More...
 
virtual ~DtRectangularPyramidModel ()
 DTOR. More...
 
Inherited from makVrv::DtModel
virtual const std::string & className () const
 Returns the name of this class. More...
 
Model setters (abstract)
virtual void setRelativePosition (double x, double y, double z)=0
 Set the relative position of the rectangular pyramid Sets the position of the model instance relative to the parent node. More...
 
virtual void setRelativeOrientation (const DtTaitBryan &ori)=0
 Set the relative orientation of the rectangular pyramid Sets the orientation of the model instance relative to the parent node. More...
 
virtual void setSize (double slantHeight)=0
 Sets the size of the rectangular pyramid. More...
 
virtual void setColor (float r, float g, float b, float a)=0
 Sets both the inside and outside colors. More...
 
virtual void setInnerColor (float r, float g, float b, float a)=0
 Sets the inner color. More...
 
virtual void setOuterColor (float r, float g, float b, float a)=0
 Sets the outer color. More...
 
virtual void setXHalfAngle (double xHalfAngle)=0
 Set the half angle amount in the x direction. More...
 
virtual void setYHalfAngle (double yHalfAngle)=0
 Set the half angle amount in the y direction. More...
 
virtual void setShowLines (bool showLines)=0
 Set whether the wireframe outlines are visible on the geometry Sets whether the wireframe lines for the pyramid should be drawn If set, the wireframe lines are drawn in addition to the geometry faces. More...
 
virtual void setLinesHaveAlpha (bool lineAlpha)=0
 Set whether the wireframe outlines should be rendered with alpha Sets whether the alpha component of the pyramid's colors should apply to the wireframe outlines as well as the faces, or just to the faces. More...
 
virtual void setIsSupportModel (bool isSupport)=0
 Set whether the model is part of the support group (whether or not other scene objects can ground clamp to this model) More...
 
- Public Member Functions inherited from makVrv::DtModel
 DtModel (DtDe &de, DtUniqueID id)
 CTOR. More...
 
virtual ~DtModel ()
 DTOR. More...
 
DtModelInstancecreateModelInstance (const std::string &modelDefName, bool realize=true)
 Set the model definition and creates an instance of the model. More...
 
virtual void setModelDefinition (const std::string &str)
 Set the model definition. More...
 
virtual const std::string & modelDefinitionName ()
 returns the model definition name. More...
 
virtual void saveModelToFile (const std::string &filename)
 
unsigned int transformSize () const
 Get the number of position/orientations this model has. More...
 
virtual void setPosition (int vtx, const DtVector &position)
 Set the position of a control vertex in the model. More...
 
virtual const DtVectorposition (int vtx=0) const
 Get the Position of a given point. More...
 
virtual void removePosition (int vtx)
 Remove a transform at the given position. More...
 
virtual void setPositionOffset (const DtVector &positionOffset)
 Set the position offset of the model. More...
 
virtual const DtVectorpositionOffset () const
 Get the Position Offset of the model. More...
 
virtual void setOrientation (int vtx, const DtTaitBryan &orientation)
 Set the orientation of a vertex in the model. More...
 
virtual void setPositionAndOrientation (int vtx, const DtVector &positionOffset, const DtTaitBryan &orientation)
 Set the position and orientation of a vertex in the model at the same time. More...
 
virtual const DtTaitBryan & orientation (int vtx=0) const
 Get the Orientation of a given point. More...
 
virtual void setOrientationOffset (const DtTaitBryan &orientationOffset)
 Set the Orientation Offset of the model. More...
 
virtual const DtTaitBryan & orientationOffset () const
 Get the Orientation Offset of the model. More...
 
virtual void enableColorBlending (bool b)
 Enable / disable color blending for this model. More...
 
virtual void setBlendColor (float r, float g, float b, float a)
 Set color to use if color blending is enabled. More...
 
virtual void getBlendColor (float &r, float &g, float &b, float &a)
 Returns the blend color. More...
 
virtual bool colorBlendingEnabled () const
 Returns whether or not blending is enabled. More...
 
virtual void enableLighting (bool l)
 set whether the model is lit; this may not be an option on all models More...
 
virtual int modelSet () const
 Get the model set this model is part of. More...
 
const DtVectorboundingBoxExtents () const
 Get the bounding box extents of the model instance. More...
 
void getBoundingBoxExtents (double &x, double &y, double &z) const
 Get the bounding box extents of the model instance. More...
 
const DtVectorboundingBoxCenter () const
 Get the bounding box center of the model instance. More...
 
virtual void getBoundingBoxCenter (double &x, double &y, double &z) const
 Get the bounding box center of the model instance. More...
 
virtual void getBoundingBoxComponents (DtVector &minimum, DtVector &maximum)
 Get the minimum and maximum X,Y,Z components of the bounding box. More...
 
void setContributesToBound (bool trueOrFalse)
 Set whether this model instance contributes to an object's overall bounding volume. More...
 
bool contributesToBound () const
 Get whether this model instance contributes to an object's overall bounding volume. More...
 
DtDede ()
 Get the DtDe object. More...
 
virtual void setModelInstance (DtModelInstance *modelInstance)
 Internally set the model instance pointer. More...
 
virtual void promoteBackgroundModelInstance (DtModelDefinition &defintion)
 Internally set the model instance pointer to the background one, also realizes and sends signal. More...
 
virtual void setVisible (bool isVisible)
 Set the visible state of the model. More...
 
virtual bool visible () const
 Get the visible state of the model. More...
 
DtUniqueID parentSceneObjectID () const
 Parent of the model. More...
 
virtual void addedToSceneObjectAsProp (const DtUniqueID &sceneObj)
 Called when a scene object added the model as a prop. More...
 
virtual void addedToSceneObject (const DtUniqueID &sceneObj, int modelSet, int visualizerType)
 Called when a scene object added the model with the given model set and visualizer type. More...
 
virtual void setElementId (DtUniqueID id)
 Called when the element ID of the model's parent object is set. More...
 
virtual void removedFromSceneObject ()
 Called when the model was removed from a scene object. More...
 
virtual void setSolid (bool isSolid)
 Set whether or not other this model is drawn filled in. More...
 
virtual bool isProp ()
 Return whether or not this model was added as a prop. More...
 
virtual void updateMinLastFrameDistance (float distance)
 updates the closest distance to an observer over the last frame More...
 
virtual void resetLastFrameDistance ()
 resets the closest distance to an observer More...
 
virtual float minLastFrameDistance () const
 gets the closest distance to an observer last frame More...
 
virtual DtModelInstancemodelInstance ()
 Get the model instance. More...
 
virtual const DtModelInstancemodelInstance () const
 
int visualizerType () const
 The visualizer type determines which channel-specific group node this model will be parented to, and consequently, which observer setting will cause it to be rendered in which channel. More...
 
virtual bool supportsMultithreadedLoad ()
 can be quickly overridden to disable background loading More...
 
virtual void backgroundLoad ()
 the chunk of loading that can safely happen in the background More...
 
virtual void foregroundLoad ()
 the chunk of loading that must happen happen in the foreground, adding to scene graph etc. More...
 
virtual bool isActivelyBackgroundLoading ()
 is this being actively loaded (it has a myInLoadQueueHandle object and it's loading) More...
 
virtual DtLoaderHandlegetLoadQueueHandle ()
 returns the load queue object More...
 

Additional Inherited Members

- Public Attributes inherited from makVrv::DtModel
boost::signal< void(DtModel *)> signal_modelToBeDestroyed
 Signal emitted when the model is to be destroyed. More...
 
boost::signal< void(DtModel *)> signal_modelChanged
 
boost::signal< bool(DtModel
*, bool), SlotReturnOR
signal_visibilityChangeRequested
 Signal when the visibility has been requested, if any slot returns false, it will not change. More...
 
boost::signal< void(DtModelInstance
*, DtModel *)> 
signal_modelInstanceCreated
 Signal emitted when the model instance is created. More...
 
boost::signal< void(DtModelInstance
*, DtModel *)> 
signal_modelInstanceToBeDestroyed
 Signal emitted when the model instance is to be destroyed. More...
 
- Protected Types inherited from makVrv::DtModel
typedef std::vector
< ObjectTransform
TransformList
 
- Protected Member Functions inherited from makVrv::DtModel
virtual void addToScene (const DtUniqueID &sceneObjectId, int modelSet, int visualizerType)=0
 Virtual Functions to be implemented, add this model to the scene. More...
 
virtual void addToSceneAsProp (const DtUniqueID &sceneObjectId)
 Add this model to the scene as a prop. More...
 
virtual void removeFromScene ()=0
 Virtual Functions to be implemented, remove this model from the scene. More...
 
virtual void initializeModelInstance ()
 Push any state maintained by the model to the model instance. More...
 
void slot_modelInstanceChanged (DtModelInstance *instance)
 Called when the model instance changed. More...
 
virtual void waitAndClearLoadHandle ()
 avoids race condition, on destruction subclasses need to wait for the model to cleanly finish loading this can happen if an object times in and out very quickly More...
 
virtual void removedFromLoadQueue ()
 deletes the myInLoadQueueHandle handle More...
 
virtual void setDoneBackgroundLoading ()
 called by async task, updates myCurrentlyLoading atomic More...
 
virtual void setActivelyBackgroundLoading ()
 called right before tbb task creation More...
 
- Protected Attributes inherited from makVrv::DtModel
DtLoaderHandlemyInLoadQueueHandle
 
DtDemyDe
 
const DtUniqueID myUniqueId
 The unique id is constant after initialization. More...
 
bool myColorBlendingEnabled
 The color blending enabled is needed to be set by the derived class so it doesn't get down to the model instances when instancing is enabled. More...
 
DtModelInstancemyBackgroundModelInstance
 holds the model created in the background for a bit More...
 
float myMinLastFrameDistance
 last frames mimimal distance to the camera, calculated by the instancing system More...
 
TransformList myTransforms
 We keep our own copy in case we get updates before we get a model instance. More...
 
DtModelInstancemyModelInstance
 
int myModelSet
 
int myVisualizerType
 
bool myContributesToBound
 
DtUniqueID myParentSceneObjectID
 
bool myIsPropFlag
 
float myBlendColor [4]
 
bool myVisibleFlag
 
DtVector myPositionOffset
 
DtTaitBryan myOrientationOffset
 
std::string myModelDefinitionName
 
- Static Protected Attributes inherited from makVrv::DtModel
static bool theInittedState
 

Detailed Description

Distributed model for visualizing synthetic aperture sensors.

Constructor & Destructor Documentation

makVrv::DtRectangularPyramidModel::DtRectangularPyramidModel ( makVrv::DtDe de,
makVrv::DtUniqueID  id 
)
virtual makVrv::DtRectangularPyramidModel::~DtRectangularPyramidModel ( )
virtual

DTOR.

Member Function Documentation

virtual const std::string& makVrv::DtRectangularPyramidModel::className ( ) const
virtual

Returns the name of this class.

See Also
makVrv::DtModel::className()

Reimplemented from makVrv::DtModel.

Reimplemented in makVrv::DtOsgRectangularPyramidModel.

virtual void makVrv::DtRectangularPyramidModel::setRelativePosition ( double  x,
double  y,
double  z 
)
pure virtual

Set the relative position of the rectangular pyramid Sets the position of the model instance relative to the parent node.

Parameters
xthe relative x translation
ythe relative y translation
zthe relative z translation

Implemented in makVrv::DtOsgRectangularPyramidModel.

virtual void makVrv::DtRectangularPyramidModel::setRelativeOrientation ( const DtTaitBryan &  ori)
pure virtual

Set the relative orientation of the rectangular pyramid Sets the orientation of the model instance relative to the parent node.

Parameters
yawthe yaw, -DtTaitBryan::psi()
pitchthe pitch, DtTaitBryan::theta()
rollthe roll, DtTaitBryan::phi()

Implemented in makVrv::DtOsgRectangularPyramidModel.

virtual void makVrv::DtRectangularPyramidModel::setSize ( double  slantHeight)
pure virtual

Sets the size of the rectangular pyramid.

Parameters
slantHeightthe length of the pyramid's slant height.

Implemented in makVrv::DtOsgRectangularPyramidModel.

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

Sets both the inside and outside colors.

Sets the color of the entire rectangular pyramid.

Parameters
rthe red component of the color
gthe green component of the color
bthe blue component of the color
athe alpha component of the color

Reimplemented from makVrv::DtModel.

Implemented in makVrv::DtOsgRectangularPyramidModel.

virtual void makVrv::DtRectangularPyramidModel::setInnerColor ( float  r,
float  g,
float  b,
float  a 
)
pure virtual

Sets the inner color.

Sets the color of the inside (near vertex) of the pyramid.

Parameters
rthe red component of the color
gthe green component of the color
bthe blue component of the color
athe alpha component of the color

Implemented in makVrv::DtOsgRectangularPyramidModel.

virtual void makVrv::DtRectangularPyramidModel::setOuterColor ( float  r,
float  g,
float  b,
float  a 
)
pure virtual

Sets the outer color.

Sets the color of the outside (far vertices) of the pyramid.

Parameters
rthe red component of the color
gthe green component of the color
bthe blue component of the color
athe alpha component of the color

Implemented in makVrv::DtOsgRectangularPyramidModel.

virtual void makVrv::DtRectangularPyramidModel::setXHalfAngle ( double  xHalfAngle)
pure virtual

Set the half angle amount in the x direction.

Parameters
xHalfAnglethe half-angle in the x direction.

Implemented in makVrv::DtOsgRectangularPyramidModel.

virtual void makVrv::DtRectangularPyramidModel::setYHalfAngle ( double  yHalfAngle)
pure virtual

Set the half angle amount in the y direction.

Parameters
yHalfAnglethe half-angle in the y direction.

Implemented in makVrv::DtOsgRectangularPyramidModel.

virtual void makVrv::DtRectangularPyramidModel::setShowLines ( bool  showLines)
pure virtual

Set whether the wireframe outlines are visible on the geometry Sets whether the wireframe lines for the pyramid should be drawn If set, the wireframe lines are drawn in addition to the geometry faces.

Parameters
showLineswhether the lines should be visible or hidden

Implemented in makVrv::DtOsgRectangularPyramidModel.

virtual void makVrv::DtRectangularPyramidModel::setLinesHaveAlpha ( bool  lineAlpha)
pure virtual

Set whether the wireframe outlines should be rendered with alpha Sets whether the alpha component of the pyramid's colors should apply to the wireframe outlines as well as the faces, or just to the faces.

Parameters
whetherthe lines should be affected by the color's alpha values.

Implemented in makVrv::DtOsgRectangularPyramidModel.

virtual void makVrv::DtRectangularPyramidModel::setIsSupportModel ( bool  isSupport)
pure virtual

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.

Implemented in makVrv::DtOsgRectangularPyramidModel.


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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)