 |
VR-Forces 4.3 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
VR-Forces 4.3 Class Documentation
|
Contains VR-Vantage objects which VR-Forces has replaced. More...
Public Member Functions | |
| DtVrfDe () | |
| virtual | ~DtVrfDe () |
 Public Member Functions inherited from makVrv::DtDe | |
| DtDe () | |
| CTOR. | |
| virtual | ~DtDe () |
| DTOR occur after the subclass of DtDe has been called. | |
| bool | destructing () |
| Get if the Display Engine is in the process of destructing (typically steps like disconnecting signals is unnecessary). | |
| virtual void | setDeInitializer (const DtDeInitializer &initializer) |
| Set the Display Engine initializer used to initialize the Display Engine. | |
| virtual void | setPathConfiguration (const DtDePathConfiguration &pathConfig) |
| Set the path configuration for an uninitialized Display Engine. | |
| virtual InitializationResult | initialize (bool abortOnLicenseFailure=true, bool useLicenseErrorDialog=true) |
| Initialize the application prior to running it. | |
| bool | initialized () const |
| Get whether the application is initialized. | |
| DtThreadId | threadId () |
| Get the thread id that the Display Engine was initialized in and must rung in. | |
| virtual void | setDeConfiguration (const DtDeConfiguration &deConfig) |
| Set the de configuration. | |
| virtual void | tick (double simTime) |
| A very important function which provides a since tick of execution which is required for the app to run for one 'logical' frame. | |
| void | retick () |
| Retick is a helper function for simply ticking using the current Simulation time. | |
| virtual bool | timeToStop () const |
| Method for checking to see if the app should stop ticking. | |
| virtual void | setTimeToStop (bool flag=true) |
| Set whether it is time to stop ticking. | |
| virtual void | quit () |
| Call this method to quit and exit the application. | |
| virtual void | reset () |
| Resets DtIG to a pre-configured state. | |
| void | updateScene () |
| Update the scene if it needs to be updated. | |
| void | registerInitFunction (void *address) |
| Register address of init function so DtDe instance knows that module was already instanced. | |
| bool | isInitFunctionRegistered (void *address) |
| Returns true if init function has already been registered. | |
| bool | shouldSendMesssage () |
| Helper function used to check if a message needs to be created and sent. | |
| void | setPagedLodMagnificationScaleFactor (float factor) |
| float | pagedLodMagnificationScaleFactor () const |
| virtual const DtDeConfiguration & | deConfiguration () const |
| DtDeConfiguration accessor. | |
| virtual DtDeCommunicator & | igCommunicator () |
| DtDeCommunicator accessor. | |
| DtMainEventQueue & | mainEventQueue () |
| DtMainEventQueue. | |
| virtual DtDisplay * | display () |
| DtDisplay accessor. | |
| virtual DtScene & | scene () |
| The DtScene accessor. | |
| virtual DtDataBank & | dataBank () |
| The DtDataBank accessor. | |
| virtual DtDriverManager & | driverManager () |
| The DtMasterScene accessor. | |
| bool | driverManagerCreated () const |
| You can call this method to see if the DtDriverManager exists. | |
| virtual DtMessageDispatcher & | dispatcher () |
| DtMessageDispatcher accessor. | |
| DtDebugLog & | log () |
| Inline access for the debug log object. | |
| DtAgentManager & | agentManager () |
| Get the scene manager. | |
| virtual double | simulationTime () const |
| Get the simulation time. | |
| virtual double | syncedTime () const |
| Get the simulation time or the synced NTP time (if the –hasNTP flag has been set) | |
| virtual int | displayCount () const |
| Get the display count. | |
| virtual const DtDeInitializer & | deInitializer () const |
| Return the DtDeInitializer. | |
| virtual const DtDePathConfiguration & | dePathConfiguration () const |
| Return the DtDePathConfiguration. | |
| virtual bool | isInMasterMode () const |
| Returns true if the DtDe is in master mode. | |
| virtual bool | isInSlaveMode () const |
| Returns true if the DtDe is in slave mode. | |
| virtual DtDeSharedState & | sharedState () |
| Returns the DtDeSharedState object. | |
| virtual const DtSchemaManager & | schemaManager () const |
| DtSchemaManager accessor. | |
| virtual DtSchemaManager & | schemaManager () |
| DtDeConfiguration accessor. | |
| virtual DtFileCache * | fileCache () |
| Returns DtFileCache. | |
| virtual const DeErrors & | deErrors () const |
| Returns myIgErrors. | |
| virtual void | clearDeErrors () |
| Clears myIgErrors. | |
| virtual DtRenderer & | renderer () const |
| Get the renderer. | |
| bool | renderFrameThisTick () const |
| Gets if we will render this frame. | |
| virtual bool | licenseAvailable () const |
| Gets if a license can be found to run with the features specified in the DtDeInitializer. | |
| virtual bool | addDisplayConfiguration (const DtDisplayConfiguration &) |
| Add a new display, if the display engine matches the local name then the de display engine is realized. | |
| virtual void | realizeDisplayConfiguration (const std::string &clientName, const std::string &displayName) |
| Make a client realize a display configuration. | |
| virtual void | destroyDisplay (DtDisplayProxySP display) |
| Remove a display. | |
| virtual void | destroyDisplay (const std::string &displayName) |
| Remove a display. | |
| virtual void | destroyAllDisplays () |
| Removes all display. | |
| virtual bool | modifyDisplay (const std::string &displayName, const DtDisplayConfiguration &config) |
| Modify a display. | |
| virtual void | onSlaveConnected (const std::string &igName) |
| Called when a client is added. | |
| virtual void | emitDeError (const DtDeError &error, bool criticalError) |
| Called when an error is emitted. | |
| virtual void | setSimulationTime (double time) |
| Set the simulation time. | |
| virtual double | systemTime () const |
| Used in special cases of absolute time stamping, this will return absolute wall clock time from the DtClock. | |
| virtual DtVirtualBaseClass * | findFastInstance (StaticInstanceFunction classInstanceFunction) const |
| Find an instance with the given name. | |
| template<typename Class > | |
| DtVirtualBaseClass * | findFastInstance (Class &(*staticInstFunc)(DtDe &)) const |
| The instance key is always return the subclass of the virtual base class, since it returns a reference (aka a pointer) it is safe to cast the function pointer. | |
| virtual void | registerFastInstance (StaticInstanceFunction classInstanceFunction, DtVirtualBaseClass *inst) |
| Register a fast instance, if the inst is a null pointer the instance key is removed. | |
| template<typename Class > | |
| void | registerFastInstance (Class &(*staticInstFunc)(DtDe &), DtVirtualBaseClass *inst) |
| The instance key is always return the subclass of the virtual base class, since it returns a reference (aka a pointer) it is safe to cast the function pointer. | |
| virtual DtVirtualBaseClass * | findInstance (const std::string &instanceName) const |
| Find an instance with the given name. | |
| virtual void | registerInstance (const std::string &instanceName, DtVirtualBaseClass *instance) |
| Register an instance with a given name for later retrieval. | |
| virtual void | registerProctor (unsigned short handlerId, DtProctor *) |
| Register an proctor object. | |
| virtual void | unregisterProctor (unsigned short handlerId) |
| Unregister a handler This should be called before the handler is deallocated. | |
| DtProctor * | findProctor (unsigned short handlerId) const |
| Find a handler. | |
| DtDisplayProxySP | findDisplay (const std::string &displayName) |
| Find a Display by name. | |
| virtual DtDisplayProxySP | findDisplayByIndex (int index) |
| Get the display by index. | |
| void | setRenderFrameThisTick (bool update) |
| Sets that the frame will be rendered this tick. | |
| virtual bool | isValidDisplayConfiguration (const DtDisplayConfiguration &dec) |
| Returns true if the display configuration is valid and can be realized. | |
Protected Member Functions | |
| virtual void | postInitialize () |
| Connect initialized components and call postInit signal. | |
| Protected Member Functions inherited from makVrv::DtDe | |
| void | slaveTick () |
| void | masterTick (double simulationTime) |
| void | renderTick () |
| Update the scene and render. | |
| DtDeProctor * | proctor () |
| Get the proctor. | |
| virtual bool | local_realizeDisplayConfiguration (const std::string &clientName, const std::string &displayName) |
| Attempt to realize a display configuration. | |
| virtual void | local_destroyDisplay (const std::string &displayName) |
| Remove a display. | |
| virtual bool | local_modifyDisplay (const std::string &displayName, const DtDisplayConfiguration &config) |
| Modify a display. | |
| void | createDisplay (DtDisplayConfiguration &) |
| create the display engine. | |
| void | createIgCommunicator (DtDriverConfiguration &config) |
| Create the Display Engine Driver. | |
| void | destroyDisplay () |
| Destroy the display. | |
| bool | local_addDisplayConfiguration (const DtDisplayConfiguration &dec) |
| Internal implementation of adding a display. | |
| virtual unsigned int | countEmbeddedWindows (const DtDisplayConfiguration &dec) |
| Count the number of embedded windows in the display configuration. | |
| virtual void | initializeSchemaManager () |
| Check whether the DtDe should skip this tick to maintain a fixed frame rate. | |
| virtual void | initializeLibXmlIfNecessary () |
| Check whether the DtDe should skip this tick to maintain a fixed frame rate. | |
| virtual bool | shouldSkipThisTick (double simulationTime) |
| Check whether the DtDe should skip this tick to maintain a fixed frame rate. | |
| virtual void | postInitializeMaster () |
| Master-only post initialize code. | |
| virtual void | checkForData () |
| Check that the data package is installed, and emit an error if not. | |
Additional Inherited Members | |
| Public Types inherited from makVrv::DtDe | |
| enum | InitializationResult { Initialized = 1, UnableToInitialize = 0, UnableToInitializeDueToLicense = -1 } |
| Result codes for the initialize() function. More... | |
| typedef std::vector< std::pair < DtDeError, bool > > | DeErrors |
| Typedef of a vector of error/critical. | |
| typedef DtVirtualBaseClass &(* | StaticInstanceFunction )(DtDe &) |
| Define the static instance function type for fast instance lookup. | |
| Static Public Member Functions inherited from makVrv::DtDe | |
| static const char * | className () |
| Returns the name of this class. | |
| Public Attributes inherited from makVrv::DtDe | |
| boost::signal< void()> | signal_initializeDefaultState |
| Signal emitted during initialization at at time when it is possible to initialize default state. | |
| boost::signal< void()> | signal_postInitialize |
| Signal emitted at the end of the initialization function. | |
| boost::signal< void(DtDe &)> | signal_preTick |
| Signal emitted at the beginning of the tick function. | |
| boost::signal< void()> | signal_postTick |
| Signal emitted at the end of the tick function. | |
| boost::signal< void(const std::string &, const std::string &)> | signal_displayConfigurationRealized |
| Emitted when a Display Engine is told to realize a display configuration. | |
| boost::signal< void(const DtDisplayConfiguration &)> | signal_displayConfigurationAdded |
| Emitted when a display is added. | |
| boost::signal< void(const std::string &)> | signal_displayToBeDestroyed |
| Emitted when a display is removed. | |
| boost::signal< void(const std::string &, const DtDisplayConfiguration &)> | signal_displayModified |
| Emitted when a display is modified. | |
| boost::signal< void(const std::string &, const DtWindowConfiguration &)> | signal_windowConfigurationAdded |
| Emitted when a window is added. | |
| boost::signal< void(const std::string &, const std::string &)> | signal_windowConfigurationToBeDestroyed |
| Emitted when a window is destroyed. | |
| boost::signal< void(const std::string &, const std::string &, const DtWindowConfiguration &)> | signal_windowConfigurationModified |
| Emitted when an realized window is modified. | |
| boost::signal< void(const std::string &, const std::string &, const DtChannelConfiguration &)> | signal_channelConfigurationAdded |
| Emitted when a channel is added. | |
| boost::signal< void(const std::string &, const std::string &, const std::string &)> | signal_channelToBeDestroyed |
| Signal is emitted, then the channel is destroyed. | |
| boost::signal< void(const std::string &, const std::string &, const std::string &, const DtChannelConfiguration &)> | signal_channelConfigurationModified |
| Emitted when a channel is modified. | |
| boost::signal< void(const DtDeError &error, bool critical)> | signal_deError |
| Listen to this signal for Display Engine errors. | |
| boost::signal< void()> | signal_quit |
| Signal emitted by the quit method. | |
| Protected Types inherited from makVrv::DtDe | |
| enum | LicenseTypes { NoLicense = -1, Master3D_License = 0, XR_License = 1, PVD_License = 2 } |
| typedef std::vector< void * > | InitFunctionVector |
| This vector stores the address of registered init functions. | |
| typedef std::map< std::string, DtVirtualBaseClass * > | RootedSingletonMap |
| typedef std::map < StaticInstanceFunction, DtVirtualBaseClass * > | FastRootedSingletonMap |
| typedef std::map< std::string, DtDisplayProxyWP > | DisplayEngineProxyMap |
| Protected Attributes inherited from makVrv::DtDe | |
| RootedSingletonMap | myRootedSingletonMap |
| FastRootedSingletonMap | myFastRootedSingletonMap |
| DtDeInitializer | myInitializer |
| DtDePathConfiguration | myPathConfiguration |
| bool | myStopFlag |
| bool | myInitializeFlag |
| double | mySimulationTime |
| double | myNextFixedTime |
| DtDebugLog | myDebugLog |
| DtDeConfiguration | myConfiguration |
| DtMainEventQueue | myMainEventQueue |
| DtDisplay * | myDisplayEngine |
| DtDeCommunicator * | myCommunicator |
| DtMessageDispatcher * | myDispatcher |
| DtDeProctor * | myIgProctor |
| DtDriverManager * | myDriverManager |
| DtAgentManager * | myAgentManager |
| DisplayEngineProxyMap | myDisplayProxies |
| DtDeSharedState * | myDeSharedState |
| DtDataBank * | myDataBank |
| DtSchemaManager * | mySchemaManager |
| InitFunctionVector | myRegisteredInitFunctions |
| void * | myRegInitFunction |
| DtFileCache * | myFileCache |
| DeErrors | myIgErrors |
| DtRenderer * | myRenderer |
| bool | mySceneNeedsUpdateFlag |
| bool | myDestructionFlag |
| bool | myInTickFlag |
| std::string | myLastInstanceName |
| RootedSingletonMap::const_iterator | myLastInstance |
| DtThreadId | myThreadId |
| DtClock * | mySimulationClock |
| double | myTimeEpoch |
| LicenseTypes | myLicenseType |
| float | myPagedLodMagnificationScaleFactor |
| Static Protected Attributes inherited from makVrv::DtDe | |
| static const char * | myClassName |
Contains VR-Vantage objects which VR-Forces has replaced.
Display engine.
| DtVrfDe::DtVrfDe | ( | ) |
|
virtual |
|
protectedvirtual |
Connect initialized components and call postInit signal.
Reimplemented from makVrv::DtDe.