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 | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
makVrf::DtVrfDe Class Reference
Inheritance diagram for makVrf::DtVrfDe:
Inheritance graph
[legend]

Public Member Functions

 DtVrfDe (const makVrv::DtVrvApplicationConfiguration &)
 
virtual ~DtVrfDe () override
 
virtual void setSimulationTime (double time) override
 
virtual void quit () override
 
virtual void setTimeToQuit (bool v)
 
bool timeToQuit () const
 
bool renderTicking () const
 
virtual void tick (double simulationTime) override
 
DtFilePrinter * filePrinter ()
 
virtual void createDebugLog (const std::string &fileName, makVrv::DtDebugLog::PrintLevel level) override
 
virtual void setDataDoesNotExist (bool)
 
bool dataDoesNotExist () const
 
virtual void setCommunicationDriver (const DtFilename &)
 
virtual void setUseSimulationTimeForAdvancement (bool)
 
virtual bool useSimulationTimeForAdvancement () const
 
- Public Member Functions inherited from makVrv::DtDe
 DtDe ()
 
virtual ~DtDe ()
 
bool destructing ()
 
bool resetting ()
 
virtual void setDeInitializer (const DtDeInitializer &initializer)
 
virtual void setPathConfiguration (const DtDePathConfiguration &pathConfig)
 
virtual InitializationResult initialize (bool abortOnLicenseFailure=true, bool useLicenseErrorDialog=true)
 
bool initialized () const
 
DtThreadId threadId ()
 
virtual void setDeConfiguration (const DtDeConfiguration &deConfig)
 
void retick ()
 
virtual bool timeToStop () const
 
virtual void setTimeToStop (bool flag=true)
 
virtual DtEnvironmentVariablesenvironmentVariables ()
 
virtual void reset ()
 
void registerInitFunction (void *address)
 
bool isInitFunctionRegistered (void *address)
 
bool shouldSendMesssage ()
 
virtual void setTargetFrameTime (double frameTimeInMs)
 
virtual double targetFrameTime ()
 
virtual void startProfilerNextFrame ()
 
virtual void stopProfilerNextFrame ()
 
virtual double lastUpdateTime () const
 
virtual void setShowErrorDialogs (bool show)
 
virtual bool showErrorDialogs () const
 
virtual void setRenderingApi (DtDe::RenderingApiType type)
 
virtual DtDe::RenderingApiType renderingApi () const
 
virtual const DtDeConfigurationdeConfiguration () const
 
virtual DtDeCommunicatorigCommunicator ()
 
DtMainEventQueuemainEventQueue ()
 
virtual DtDisplaydisplay ()
 
virtual DtScenescene ()
 
virtual DtDataBankdataBank ()
 
virtual DtDriverManagerdriverManager ()
 
bool driverManagerCreated () const
 
virtual DtMessageDispatcherdispatcher ()
 
DtDebugLoglog ()
 
DtAgentManageragentManager ()
 
DtBackgroundLoaderbackgroundLoader ()
 
virtual double simulationTime () const
 
virtual double syncedTime () const
 
virtual DtSynchronizedTimeManagerfindSynchronizedTimeManager ()
 
virtual int displayCount () const
 
virtual const DtDeInitializerdeInitializer () const
 
virtual const
DtDePathConfiguration
dePathConfiguration () const
 
virtual bool isInMasterMode () const
 
virtual bool isInSlaveMode () const
 
virtual DtDeSharedStatesharedState ()
 
virtual const DtDeSharedStatesharedState () const
 
virtual const DtDeSharedState
*const 
sharedStatePtr () const
 
virtual const DtSchemaManagerfindSchemaManager () const
 
virtual DtSchemaManagerfindSchemaManager ()
 
virtual DtFileCachefileCache ()
 
virtual const DeErrors deErrors () const
 
virtual void clearDeErrors ()
 
virtual DtRendererrenderer () const
 
bool renderFrameThisTick () const
 
virtual bool licenseAvailable () const
 
virtual DtDrawnIntersectorManagerdrawnIntersectorManager ()
 
virtual const
DtDrawnIntersectorManager
drawnIntersectorManager () const
 
virtual bool addDisplayConfiguration (const DtDisplayConfiguration &)
 
virtual void realizeDisplayConfiguration (const std::string &clientName, const std::string &displayName)
 
virtual void destroyDisplay (DtDisplayProxySP display)
 
virtual void destroyDisplay (const std::string &displayName)
 
virtual void destroyAllDisplays ()
 
virtual bool modifyDisplay (const std::string &displayName, const DtDisplayConfiguration &config)
 
virtual void onSlaveConnected (const std::string &igName)
 
virtual void emitDeError (const DtDeError &error, bool criticalError)
 
virtual double systemTime () const
 
virtual void setCurrentFrameNumber (unsigned int frameNumber)
 
virtual unsigned int currentFrameNumber () const
 
virtual bool isPaused () const
 
virtual void pause ()
 
virtual void resume ()
 
double pausedTime () const
 
virtual DtVirtualBaseClassfindFastInstance (StaticInstanceFunction classInstanceFunction) const
 
template<typename Class >
DtVirtualBaseClassfindFastInstance (Class &(*staticInstFunc)(DtDe &)) const
 
virtual void registerFastInstance (StaticInstanceFunction classInstanceFunction, DtVirtualBaseClass *inst)
 
template<typename Class >
void registerFastInstance (Class &(*staticInstFunc)(DtDe &), DtVirtualBaseClass *inst)
 
virtual DtVirtualBaseClassfindInstance (const std::string &instanceName) const
 
virtual void registerInstance (const std::string &instanceName, DtVirtualBaseClass *instance)
 
virtual void registerProctor (unsigned short handlerId, DtProctor *)
 
virtual void unregisterProctor (unsigned short handlerId)
 
DtProctorfindProctor (unsigned short handlerId) const
 
DtDisplayProxySP findDisplay (const std::string &displayName)
 
virtual DtDisplayProxySP findDisplayByIndex (int index)
 
void setRenderFrameThisTick (bool update)
 
virtual bool modelSetActive (DtModelSetId i) const
 
virtual void determineActiveModelSets ()
 
virtual bool isValidDisplayConfiguration (const DtDisplayConfiguration &dec)
 
virtual void startLogFrameTime ()
 
virtual void stopLogFrameTime ()
 

Static Public Member Functions

static void setEnableLogFileTimeStamps (bool)
 
static bool enableLogFileTimeStamps ()
 
- Static Public Member Functions inherited from makVrv::DtDe
static const charclassName ()
 

Protected Member Functions

virtual void slot_backendRemoved (const DtVrfBackendState &)
 
virtual void slot_selectedBackendChanged (const DtSimulationAddress &, const DtSimulationAddress &)
 
virtual void initializeSchemaManager () override
 
virtual bool waitingForBackendQuitMessage ()
 
virtual void updateScene () override
 
virtual void renderTick (double elapsedTime) override
 
virtual void postInitialize () override
 
virtual void startCommunicationDriver (const makVrv::DtDriver &)
 
- Protected Member Functions inherited from makVrv::DtDe
void slaveTick ()
 
void masterTick (double simulationTime)
 
DtDeProctorproctor ()
 
virtual bool local_realizeDisplayConfiguration (const std::string &clientName, const std::string &displayName)
 
virtual void local_destroyDisplay (const std::string &displayName)
 
virtual bool local_modifyDisplay (const std::string &displayName, const DtDisplayConfiguration &config)
 
void createDisplay (DtDisplayConfiguration &)
 
void createIgCommunicator (DtDriverConfiguration &config)
 
void destroyDisplay ()
 
bool local_addDisplayConfiguration (const DtDisplayConfiguration &dec)
 
virtual void intializeStatsManager (void)
 
virtual unsigned int countEmbeddedWindows (const DtDisplayConfiguration &dec)
 
virtual void initializeLibXmlIfNecessary ()
 
virtual bool shouldSkipThisTick (double simulationTime)
 
virtual void postInitializeMaster ()
 
virtual void checkForData ()
 

Protected Attributes

bool myRenderTicking = false
 
DtFilename myCommunicationDriver
 
DtVrfSimBackendManagermyBackendManager
 
DtTime myLastTimeSet
 
DtClock myClock
 
DtVrfBackendStatemyCurrentBackend
 
bool myUseSimulationTimeForAdvancement
 
bool myTimeToQuit
 
DtFilename myDebugLogFile
 
DtFilePrinter * myFilePrinter
 
bool myDataDoesNotExist
 
DtGateLock myGateLock
 
- Protected Attributes inherited from makVrv::DtDe
RootedSingletonMap myRootedSingletonMap
 
FastRootedSingletonMap myFastRootedSingletonMap
 
DtDeInitializer myInitializer
 
DtDePathConfiguration myPathConfiguration
 
bool myStopFlag
 
bool myInitializeFlag
 
double mySimulationTime
 
unsigned int myCurrentFrameNumber
 
double myNextFixedTime
 
DtDebugLogmyDebugLog
 
DtDeConfiguration myConfiguration
 
DtMainEventQueue myMainEventQueue
 
DtDisplaymyDisplayEngine
 
DtDeCommunicatormyCommunicator
 
DtMessageDispatchermyDispatcher
 
DtDeProctormyIgProctor
 
DtDriverManagermyDriverManager
 
DtAgentManagermyAgentManager
 
DisplayEngineProxyMap myDisplayProxies
 
DtDeSharedStatemyDeSharedState
 
DtDataBankmyDataBank
 
DtSchemaManagermySchemaManager
 
DtBackgroundLoadermyBackgroundLoader
 
InitFunctionVector myRegisteredInitFunctions
 
void * myRegInitFunction
 
DtFileCachemyFileCache
 
DeErrors myIgErrors
 
DtRenderermyRenderer
 
bool mySceneNeedsUpdateFlag
 
bool myDestructionFlag
 
bool myInTickFlag
 
std::vector< boolmyActiveModelSets
 
std::string myLastInstanceName
 
RootedSingletonMap::const_iterator myLastInstance
 
std::shared_timed_mutex myInternalDataMutex
 
std::shared_timed_mutex myErrorMutex
 
DtThreadId myThreadId
 
DtClockmySimulationClock
 
DtSynchronizedTimeManagermySynchronizedTimeManager
 
LicenseTypes myLicenseType
 
DtInMemoryProfilerDistributorAgent * myFrameTimeLogger
 
bool myRenderedLastFrame
 
bool myResettingFlag
 
double mySystemPausedTime
 
double myTargetFrameTime
 
double myLastUpdateTime
 
bool myStartProfilerNextFrame
 
bool myStopProfilerNextFrame
 
DtDrawnIntersectorManagermyDrawnIntersectorManager = nullptr
 
bool myShowErrorDialogs
 
RenderingApiType myRenderingApi
 
DtEnvironmentVariablesmyCachedEnvironmentVariables
 

Static Protected Attributes

static bool theEnableLogFileTimeStamps
 
- Static Protected Attributes inherited from makVrv::DtDe
static const charmyClassName
 

Additional Inherited Members

- Public Types inherited from makVrv::DtDe
enum  RenderingApiType { RenderingApiType::None, RenderingApiType::OpenGL }
 
enum  InitializationResult { Initialized = 1, UnableToInitialize = 0, UnableToInitializeDueToLicense = -1 }
 
typedef std::vector< std::pair
< DtDeError, bool > > 
DeErrors
 
typedef DtVirtualBaseClass &(* StaticInstanceFunction )(DtDe &)
 
- Public Attributes inherited from makVrv::DtDe
boost::signalslib::signal< void()> signal_initializeDefaultState
 
boost::signalslib::signal< void()> signal_postInitialize
 
boost::signalslib::signal
< void(DtDe &)> 
signal_preTick
 
boost::signalslib::signal< void()> signal_postTick
 
boost::signalslib::signal
< void(const std::string
&, const std::string &)> 
signal_displayConfigurationRealized
 
boost::signalslib::signal
< void(const
DtDisplayConfiguration &)> 
signal_displayConfigurationAdded
 
boost::signalslib::signal
< void(const std::string &)> 
signal_displayToBeDestroyed
 
boost::signalslib::signal
< void(const std::string
&, const
DtDisplayConfiguration &)> 
signal_displayModified
 
boost::signalslib::signal
< void(const std::string
&, const DtWindowConfiguration &)> 
signal_windowConfigurationAdded
 
boost::signalslib::signal
< void(const std::string
&, const std::string &)> 
signal_windowConfigurationToBeDestroyed
 
boost::signalslib::signal
< void(const std::string
&, const std::string &, const
DtWindowConfiguration &)> 
signal_windowConfigurationModified
 
boost::signalslib::signal
< void(const std::string
&, const std::string &, const
DtChannelConfiguration &)> 
signal_channelConfigurationAdded
 
boost::signalslib::signal
< void(const std::string
&, const std::string &, const
std::string &)> 
signal_channelToBeDestroyed
 
boost::signalslib::signal
< void(const std::string
&, const std::string &, const
std::string &, const
DtChannelConfiguration &)> 
signal_channelConfigurationModified
 
boost::signalslib::signal< void()> signal_postMainWindowInitialize
 
boost::signalslib::signal
< void(const DtDeError &error,
bool critical)> 
signal_deError
 
boost::signalslib::signal< void()> signal_quit
 
boost::signalslib::signal< void()> signal_pause
 
boost::signalslib::signal< void()> signal_resume
 
boost::signalslib::signal< void()> signal_aboutToAutoStartDrivers
 
- Protected Types inherited from makVrv::DtDe
enum  LicenseTypes { NoLicense = -1, Master3D_License = 0, XR_License = 1, PVD_License = 2 }
 
typedef std::vector< void * > InitFunctionVector
 
typedef std::map< std::string,
DtVirtualBaseClass * > 
RootedSingletonMap
 
typedef std::map
< StaticInstanceFunction,
DtVirtualBaseClass * > 
FastRootedSingletonMap
 
typedef std::map< std::string,
DtDisplayProxyWP
DisplayEngineProxyMap
 

Constructor & Destructor Documentation

makVrf::DtVrfDe::DtVrfDe ( const makVrv::DtVrvApplicationConfiguration )

CTOR.

virtual makVrf::DtVrfDe::~DtVrfDe ( )
overridevirtual

DTOR.

Member Function Documentation

virtual void makVrf::DtVrfDe::setSimulationTime ( double  time)
overridevirtual

Sets the simulation time. If time multiplier in VRF is not 1 then internally sets sim time to be difference from last elapsed real time (from when sim time was set) and current elapsedRealTime multiplied by the multiplier.

Reimplemented from makVrv::DtDe.

virtual void makVrf::DtVrfDe::setUseSimulationTimeForAdvancement ( bool  )
virtual

Sets whether or not to use simulation time (true) or wall clock time for advancement. Default is to use wall clock time.

virtual bool makVrf::DtVrfDe::useSimulationTimeForAdvancement ( ) const
virtual

Sets whether or not to use simulation time (true) or wall clock time for advancement. Default is to use wall clock time.

virtual void makVrf::DtVrfDe::quit ( )
overridevirtual

Call this method to quit and exit the application.

Reimplemented from makVrv::DtDe.

virtual void makVrf::DtVrfDe::setTimeToQuit ( bool  v)
virtual
bool makVrf::DtVrfDe::timeToQuit ( ) const
inline
bool makVrf::DtVrfDe::renderTicking ( ) const
inline
virtual void makVrf::DtVrfDe::tick ( double  simTime)
overridevirtual

A very important function which provides a since tick of execution which is required for the app to run for one 'logical' frame. This function must be called repeatedly typically as often as possible.

Exceptions
DtCorruptedStateif called before the Display Engine is initialized.
Parameters
Input
simTimeis the simulation time of the 'update cycle'. Typically this is the amount of time in seconds since the DtDe was started (to get real time behavior).

Reimplemented from makVrv::DtDe.

DtFilePrinter* makVrf::DtVrfDe::filePrinter ( )
inline
static void makVrf::DtVrfDe::setEnableLogFileTimeStamps ( bool  )
static
static bool makVrf::DtVrfDe::enableLogFileTimeStamps ( )
static
virtual void makVrf::DtVrfDe::createDebugLog ( const std::string &  fileName,
makVrv::DtDebugLog::PrintLevel  level 
)
overridevirtual

create the debug log for logging information to a file

Reimplemented from makVrv::DtDe.

virtual void makVrf::DtVrfDe::setDataDoesNotExist ( bool  )
virtual
bool makVrf::DtVrfDe::dataDoesNotExist ( ) const
inline
virtual void makVrf::DtVrfDe::setCommunicationDriver ( const DtFilename &  )
virtual
virtual void makVrf::DtVrfDe::slot_backendRemoved ( const DtVrfBackendState )
protectedvirtual
virtual void makVrf::DtVrfDe::slot_selectedBackendChanged ( const DtSimulationAddress &  ,
const DtSimulationAddress &   
)
protectedvirtual
virtual void makVrf::DtVrfDe::initializeSchemaManager ( )
overrideprotectedvirtual

Check whether the DtDe should skip this tick to maintain a fixed frame rate.

Reimplemented from makVrv::DtDe.

virtual bool makVrf::DtVrfDe::waitingForBackendQuitMessage ( )
protectedvirtual
virtual void makVrf::DtVrfDe::updateScene ( )
overrideprotectedvirtual

Update the scene if it needs to be updated.

Reimplemented from makVrv::DtDe.

virtual void makVrf::DtVrfDe::renderTick ( double  elapsedTime)
overrideprotectedvirtual

Update the scene and render, elapsedTimeis used to figure out how much time is left for additional streaming.

Reimplemented from makVrv::DtDe.

virtual void makVrf::DtVrfDe::postInitialize ( )
overrideprotectedvirtual

Connect initialized components and call postInit signal.

Reimplemented from makVrv::DtDe.

virtual void makVrf::DtVrfDe::startCommunicationDriver ( const makVrv::DtDriver )
protectedvirtual

Member Data Documentation

bool makVrf::DtVrfDe::myRenderTicking = false
protected
DtFilename makVrf::DtVrfDe::myCommunicationDriver
protected
DtVrfSimBackendManager* makVrf::DtVrfDe::myBackendManager
protected
DtTime makVrf::DtVrfDe::myLastTimeSet
protected
DtClock makVrf::DtVrfDe::myClock
protected
DtVrfBackendState* makVrf::DtVrfDe::myCurrentBackend
protected
bool makVrf::DtVrfDe::myUseSimulationTimeForAdvancement
protected
bool makVrf::DtVrfDe::myTimeToQuit
protected
DtFilename makVrf::DtVrfDe::myDebugLogFile
protected
DtFilePrinter* makVrf::DtVrfDe::myFilePrinter
protected
bool makVrf::DtVrfDe::theEnableLogFileTimeStamps
staticprotected
bool makVrf::DtVrfDe::myDataDoesNotExist
protected
DtGateLock makVrf::DtVrfDe::myGateLock
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)