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 | Friends
makVrv::DtSceneDriver Class Reference

The DtSceneDriver owns the scene.

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

Public Member Functions

virtual ~DtSceneDriver ()
 
virtual bool onStart ()
 
virtual bool onStop ()
 
virtual bool onTick ()
 
virtual const std::string & className () const
 
bool saveScene (const std::string &filePath, bool saveAs=true)
 
bool loadScene (const std::string &filePath, bool emitSignal=true)
 
const std::string & sceneFileName () const
 
DtScenefindScene ()
 
DtScenescene ()
 
virtual void clearScene ()
 
- Public Member Functions inherited from makVrv::DtDriver
 DtDriver (DtAgentManager &agentManager, const std::string &instanceName)
 
virtual ~DtDriver ()
 
virtual void realizeConfiguration (const DtConfiguration &configuration)
 
virtual DtConfiguration createConfiguration (bool saveAllParameters=false) const
 
DtAgentManageragentManager ()
 
virtual DtAgentManagerInterfacesceneInterface ()
 
bool started () const
 
virtual const std::string & instanceName () const
 
virtual bool autoStart () const
 
virtual void setAutoStart (bool autoStart)
 
virtual bool isWindowDependent () const
 
virtual void setIsWindowDependent (bool dep)
 
virtual void setIsUserControllable (bool)
 
virtual bool isUserControllable () const
 
virtual void setIsPersistent (bool per)
 
virtual bool isPersistent () const
 
virtual bool isOnDriverSelectionList () const
 
virtual void setOnDriverSelectionList (bool)
 
bool objectFromAgentManager (const DtUniqueID &id) const
 

Protected Member Functions

 DtSceneDriver (DtDe &de)
 
void reportPropCreated (const DtProp &prop)
 
void reportPropDestroyed (const DtProp &prop)
 
void reportBuoyCreated (const DtBuoyOrBeaconFacade &buoy)
 
void reportBuoyDestroyed (const DtBuoyOrBeaconFacade &buoy)
 
void reportTerrainPatchCreated (const DtTerrainPatch &patch)
 
void reportTerrainPatchDestroyed (const DtTerrainPatch &patch)
 
void reportFeatureCreated (const DtFeature &feature)
 
void reportFeatureDestroyed (const DtFeature &feature)
 
virtual void slot_displayEngineAdded (const DtDeRecord &igRecord)
 
virtual void slot_elementAttributeChangeRequested (DtUniqueID id, DtUniqueID parentId, std::shared_ptr< const DtElementAttribute > atr)
 
void handlePropElementChanged (DtProp &prop, const DtElementAttribute *attr)
 
- Protected Member Functions inherited from makVrv::DtDriver
void applyChangesAndDelete (DtElementChanges *changes)
 
void reportElementCreated (DtElementID id, DtElementID parentId, DtElementEntry::ElementType type)
 
void reportElementAttribute (DtElementID id, DtElementAttribute *attribute)
 
void reportElementDestroyed (DtElementID id)
 
void start ()
 
void stop ()
 
bool tick ()
 
virtual void setInstanceName (const std::string &name)
 
virtual void installAccessories ()
 
virtual void uninstallAccessories ()
 

Protected Attributes

std::string myClassName
 
DtDemyDe
 
DtScenemyScene
 
std::string mySceneFileName
 
- Protected Attributes inherited from makVrv::DtDriver
DtAgentManagermyAgentManager
 
bool myStartedFlag
 
std::string myName
 
DtConfiguration myConfiguration
 
bool myPersistentFlag
 
bool myUserControllableFlag
 
bool myRequestStateDiffPendingFlag
 
DtElementChanges myChanges
 

Friends

class DtSceneDriverCreator
 

Additional Inherited Members

- Static Protected Attributes inherited from makVrv::DtDriver
static const std::string theOnDriverSelectionList
 

Constructor & Destructor Documentation

virtual makVrv::DtSceneDriver::~DtSceneDriver ( )
virtual

DTOR.

makVrv::DtSceneDriver::DtSceneDriver ( DtDe de)
protected

CTOR.

Member Function Documentation

virtual bool makVrv::DtSceneDriver::onStart ( )
virtual

Called then this host is stared.

Implements makVrv::DtDriver.

virtual bool makVrv::DtSceneDriver::onStop ( )
virtual

Called when this host is stopped.

Implements makVrv::DtDriver.

virtual bool makVrv::DtSceneDriver::onTick ( )
virtual

Called when this host is ticked.

Implements makVrv::DtDriver.

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

Ge the class name for the scene driver.

Implements makVrv::DtDriver.

bool makVrv::DtSceneDriver::saveScene ( const std::string &  filePath,
bool  saveAs = true 
)

Save the scene to a file.

Parameters
Input
filePathis the location of the file to save.
saveAsindicates whether saving the file sets the current filename.
bool makVrv::DtSceneDriver::loadScene ( const std::string &  filePath,
bool  emitSignal = true 
)

Load the scene from a file.

Parameters
emitSignalwhether emit the load scene signal which will add the scene to the recents terrains
const std::string& makVrv::DtSceneDriver::sceneFileName ( ) const

Get the file name of the loaded scene.

Return values
""is the scene was not loaded/saved from a file.
DtScene* makVrv::DtSceneDriver::findScene ( )

Attempt to get the scene.

Return values
0is the scene driver is not started.
DtScene& makVrv::DtSceneDriver::scene ( )

Get the scene object for the driver.

Exceptions
DtCorruptedStateif the scene driver has not been started.
virtual void makVrv::DtSceneDriver::clearScene ( )
virtual

Removes all drawable objects from the scene. This includes, Terrains, Props, trees, etc.

void makVrv::DtSceneDriver::reportPropCreated ( const DtProp prop)
protected

Report that a prop was created.

void makVrv::DtSceneDriver::reportPropDestroyed ( const DtProp prop)
protected

Report that a prop was destroyed.

void makVrv::DtSceneDriver::reportBuoyCreated ( const DtBuoyOrBeaconFacade buoy)
protected
void makVrv::DtSceneDriver::reportBuoyDestroyed ( const DtBuoyOrBeaconFacade buoy)
protected
void makVrv::DtSceneDriver::reportTerrainPatchCreated ( const DtTerrainPatch patch)
protected

Report that a terrain patch was created.

void makVrv::DtSceneDriver::reportTerrainPatchDestroyed ( const DtTerrainPatch patch)
protected

Report that a terrain patch was destroyed.

void makVrv::DtSceneDriver::reportFeatureCreated ( const DtFeature feature)
protected

Report that a feature was created.

void makVrv::DtSceneDriver::reportFeatureDestroyed ( const DtFeature feature)
protected

Report that a feature was destroyed.

virtual void makVrv::DtSceneDriver::slot_displayEngineAdded ( const DtDeRecord igRecord)
protectedvirtual

Called when a display engine is added. This saves the scene and reloads it so the slaves are synced up with the terrain and environment.

Reimplemented from makVrv::DtDriver.

virtual void makVrv::DtSceneDriver::slot_elementAttributeChangeRequested ( DtUniqueID  id,
DtUniqueID  parentId,
std::shared_ptr< const DtElementAttribute atr 
)
protectedvirtual
void makVrv::DtSceneDriver::handlePropElementChanged ( DtProp prop,
const DtElementAttribute attr 
)
protected

Friends And Related Function Documentation

friend class DtSceneDriverCreator
friend

Allow the creator to create instances of the scene driver.

Member Data Documentation

std::string makVrv::DtSceneDriver::myClassName
protected
DtDe& makVrv::DtSceneDriver::myDe
protected
DtScene* makVrv::DtSceneDriver::myScene
protected
std::string makVrv::DtSceneDriver::mySceneFileName
protected

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

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)