makVrv::DtSmokeElement Class Reference

vrvCore Smoke Element

Inheritance diagram for makVrv::DtSmokeElement:

Classes
struct	DtSmokeModelSetData

Public Types
using	ModelSetDataArray = std::array< DtSmokeModelSetData, MAX_MODEL_SETS >
Public Types inherited from makVrv::DtElement
using	ModelSetToSceneObjectIdMap = boost::unordered_map< DtModelSetId, DtUniqueID >

Public Member Functions
	DtSmokeElement (DtBaseConnection &conn, DtStateListener &listener)
virtual	~DtSmokeElement ()
	DtSmokeElement ()=delete
	DtSmokeElement (const DtSmokeElement &)=delete
DtSmokeElement &	operator= (const DtSmokeElement &)=delete
virtual const DtElementEntry::ElementType	elementType () const override
virtual void	visualize (const DtSharedModelSetSettings::ModelSetVisualizedMap &sets)
virtual void	setModelSetEnabled (DtModelSetId modelSet, bool enabled) override
virtual void	setObjectIsVisible (bool visible)
virtual bool	objectIsVisible () const
virtual const ModelSetDataArray &	modelSetDataArray () const
DtSmokeVisualizerSet *	findVisualizerSetForModelSet (DtModelSetId modelSet) const
template<typename VisualizerClass >
void	findVisualizers (std::vector< VisualizerClass * > &visualizers)
Public Member Functions inherited from makVrv::DtElement
	DtElement (DtBaseConnection &conn, DtElementID elementId)
virtual	~DtElement ()
	DtElement ()=delete
	DtElement (const DtElement &)=delete
DtElement &	operator= (const DtElement &)=delete
virtual void	setVisible (bool visible)
virtual bool	visible () const
virtual void	setElementId (const DtElementID)
DtElementID	elementID () const
virtual const DtUnicode &	elementDefinition () const
virtual void	setElementDefinition (const DtUnicode &definition)
virtual std::string	displayUnitCollectionName () const
virtual void	setDisplayUnitCollectionName (const std::string &definition)
virtual void	setDriverType (const std::string &driverType)
virtual void	setElementSubtype (DtElementAttributes::ElementSubtypes subtype)
virtual void	changeElementAttribute (const DtElementAttribute *attr)
virtual void	updateElementDefinitionFromDefinitions ()
virtual void	updateElementDefinitionFromDefinitions (std::vector< DtUnicode > &definitions)
virtual ModelSetToSceneObjectIdMap &	modelSetToSceneObjectIdMap ()
virtual void	setSceneObjectIdForModelSet (DtModelSetId modelSet, DtUniqueID id)
virtual void	removeSceneObjectIdForModelSet (DtModelSetId modelSet)
virtual DtUniqueID	sceneObjectIdForModelSet (DtModelSetId modelSet) const

Static Public Member Functions
static const DtElementEntry::ElementType	theElementType ()

Protected Member Functions
virtual void	slot_visibilityChanged (bool vis)
Protected Member Functions inherited from makVrv::DtElement
void	slot_updateOverlayNameRaw (const char *text)
void	slot_updateConnectionObjectID (const std::string &id)
void	slot_updateConnectionObjectType (const std::string &type)
void	slot_updateDisplayName (const std::string &text)
void	slot_updateOverlayName (const std::string &pname)
void	slot_updateDamageState (EntityStateListener::DamageState state)
virtual void	getDefinitions (std::vector< DtUnicode > &definitions)
virtual void	warnVisualizationFailed (const std::string &file, int line, const std::string &function, DtVisualizerSet *visSet, DtSceneObjectAgent *sceneObject, DtModelSetId modelSet, DtException ex)
virtual void	reportElementCreated ()
virtual void	reportDisplayName ()
virtual void	reportConnectionObjectID ()
virtual void	reportConnectionObjectType ()
virtual void	reportOverlayNameChanged ()
virtual void	reportVisibility ()
virtual void	reportDamageStateChanged ()
virtual void	reportDriverType ()
virtual void	reportElementSubtype ()
virtual void	reportElementDefinitionName ()
virtual void	reportDisplayUnitCollectionName ()
virtual bool	distribute () const
virtual void	setDistribute (const bool distribute)

Protected Attributes
DtSmokeStateListener *	mySmokeListener
DtSignalConnectionManager	myConnections
ModelSetDataArray	myModelSetDataArray
Protected Attributes inherited from makVrv::DtElement
DtAgentManagerInterface &	mySceneInterface
DtSharedSettingsManager &	mySettingsManager
const DtVisualizerCreationSettings::VisualTypeVisualizerCreationMap &	myVisualTypeVisualizerCreationMap
DtBaseConnection &	myBaseConnection
DtElementID	myElementId
DtUnicode	myElementDefinitionName
const DtElementDefinition *	myElementDefinition
std::string	myDisplayUnitCollectionName
std::string	myConnectionObjectID
std::string	myConnectionObjectType
std::string	myDisplayName
std::string	myElementOverlayName
std::string	myDriverType
DtElementAttributes::ElementSubtypes	myElementSubtype
EntityStateListener::DamageState	myDamageState
bool	myElementVisible
bool	myElementReported
bool	myDistribute
ModelSetToSceneObjectIdMap	myModelSetToSceneObjectIdMap

Member Typedef Documentation

using makVrv::DtSmokeElement::ModelSetDataArray = std::array<DtSmokeModelSetData, MAX_MODEL_SETS>

MAX_MODEL_SETS is defined in DtModelSetEnums.h.

Constructor & Destructor Documentation

makVrv::DtSmokeElement::DtSmokeElement	(	DtBaseConnection &	conn,
		DtStateListener &	listener
	)

CTOR.

virtual makVrv::DtSmokeElement::~DtSmokeElement ( )

virtual

DTOR.

makVrv::DtSmokeElement::DtSmokeElement ( )

delete

not allowed - default constructor

makVrv::DtSmokeElement::DtSmokeElement ( const DtSmokeElement &  )

delete

not allowed - copy constructor

Member Function Documentation

DtSmokeElement& makVrv::DtSmokeElement::operator= ( const DtSmokeElement &  )

delete

not allowed - equals operator

virtual const DtElementEntry::ElementType makVrv::DtSmokeElement::elementType ( ) const

overridevirtual

Returns the element type, in this case smoke.

Implements makVrv::DtElement.

static const DtElementEntry::ElementType makVrv::DtSmokeElement::theElementType ( )

static

virtual void makVrv::DtSmokeElement::visualize ( const DtSharedModelSetSettings::ModelSetVisualizedMap &  sets )

virtual

Visualize the element. Finds the element definition DtSharedModelSetSettings::ModelSetVisualizedMap contains the model sets that are to be visualized. Each entry in the map is passed to setModelSetEnabled to either be created or destroyed if it has already been created.

Reimplemented from makVrv::DtElement.

virtual void makVrv::DtSmokeElement::setModelSetEnabled ( DtModelSetId  modelSet, bool  enabled  )

overridevirtual

Sets the particular model set up. Does nothing if it already exists. This method does a large portion of element creation. It creates the sceneObject agent, the visualizer set.

Implements makVrv::DtElement.

virtual void makVrv::DtSmokeElement::setObjectIsVisible ( bool  visible )

virtual

virtual bool makVrv::DtSmokeElement::objectIsVisible ( ) const

virtual

virtual const ModelSetDataArray& makVrv::DtSmokeElement::modelSetDataArray ( ) const

virtual

Get the current model set array.

DtSmokeVisualizerSet* makVrv::DtSmokeElement::findVisualizerSetForModelSet

(

DtModelSetId

modelSet

)

const

Attempt to find a visualizer set for a given model set, can return nullptr;.

template<typename VisualizerClass >

void makVrv::DtSmokeElement::findVisualizers ( std::vector< VisualizerClass * > &  visualizers )

inline

virtual void makVrv::DtSmokeElement::slot_visibilityChanged ( bool  vis )

protectedvirtual

Called when the listener indicates the element has become visible or not Calls DtElement::setVisible( vis ); to report element attribute visibility change.

Member Data Documentation

DtSmokeStateListener* makVrv::DtSmokeElement::mySmokeListener

protected

DtSignalConnectionManager makVrv::DtSmokeElement::myConnections

protected

ModelSetDataArray makVrv::DtSmokeElement::myModelSetDataArray

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtSmokeElement.h