DOP_Parent Class Reference
#include <DOP_Parent.h>
Public Member Functions | |
| DOP_Parent () | |
| virtual | ~DOP_Parent () |
| const DOP_Engine & | getEngine () const |
| DOP_Engine & | getNonConstEngine () |
| void | setNeedsToResimulateLastTimestep () |
| void | setNeedsToFilterData () |
| void | setDOPTime (const SIM_Time &t) |
| const SIM_Time | getDOPTime (const SIM_Time &t) const |
| const SIM_Time | getGlobalTime (const SIM_Time &t) const |
| void | resimulate () |
| void | resimulateToTime (const SIM_Time &t) |
| bool | getNeedsResimulation () const |
| const SIM_Time & | getOffsetTime () const |
| Attributes for controlling the simulation behavior. | |
| void | setOffsetTime (const SIM_Time &t) |
| fpreal | getTimeScale () const |
| void | setTimeScale (fpreal scale) |
| bool | getAutoResimulation () const |
| void | setAutoResimulation (bool autoreset) |
| bool | getInterpolateData (const SIM_Time &t) const |
| void | setInterpolateData (bool interpolate) |
| bool | getIsSimulating () const |
| virtual bool | getIsTimeless () const |
| void | setIsSimulating (bool val) |
| void | findAllObjectsFromString (const char *objspec, SIM_ConstObjectArray &objects, const SIM_Time &t) const |
| const SIM_Object * | findObjectFromString (const char *objspec, int whichmatch, int *nummatch, const SIM_Time &t) const |
| void | findAllRelationshipsFromString (const char *relspec, SIM_ConstDataArray &relationships, const SIM_Time &t) const |
| const SIM_Relationship * | findRelationshipFromString (const char *relspec, int whichmatch, int *nummatch, const SIM_Time &t) const |
| DOP_Node::DOP_CookData & | getDopNodeCookData () |
| void | sendResimulateNotification (bool callnotify, bool changingguideparm) |
| DEP_MicroNode & | simMicroNode () |
Static Public Member Functions | |
| static const DOP_ParentList & | getAllDopParents () |
| This static function returns an array of all DOP_Parents. | |
| static void | setMostRecentDopParent (DOP_Parent *dopparent) |
| static OP_Node * | getMostRecentDopOwner () |
Protected Member Functions | |
| const SIM_Time & | getLastSetTime () const |
| void | resimulateLastTimestep () |
| void | setNeedsToFilterData (const SIM_Time &t) |
| void | filterDataIfRequired () const |
| Check if we need to filter our simulation data, and do so if required. | |
| void | filterData (const SIM_Time &t) |
| virtual const DOP_Engine & | getEngineSubclass () const =0 |
| virtual void | resimulateLastTimestepSubclass () |
| virtual void | setDOPTimeSubclass (const SIM_Time &t) |
| virtual DOP_Engine & | getNonConstEngineSubclass ()=0 |
| virtual void | filterDataSubclass (const SIM_Time &t)=0 |
| void | notifySimulationChangeSinksOfChange () |
| void | notifySimulationChangeSinksOfDelete () |
Friends | |
| class | DOP_SimulationChangeSink |
Detailed Description
- Examples:
Definition at line 39 of file DOP_Parent.h.
Constructor & Destructor Documentation
| DOP_Parent::DOP_Parent | ( | ) |
| virtual DOP_Parent::~DOP_Parent | ( | ) | [virtual] |
Member Function Documentation
| void DOP_Parent::filterData | ( | const SIM_Time & | t | ) | [protected] |
This function calls filterDataSubclass() to cache pointers to the simulation data that is of interest to us.
| void DOP_Parent::filterDataIfRequired | ( | ) | const [protected] |
Check if we need to filter our simulation data, and do so if required.
| virtual void DOP_Parent::filterDataSubclass | ( | const SIM_Time & | t | ) | [protected, pure virtual] |
Implemented in OBJ_DopNet.
| void DOP_Parent::findAllObjectsFromString | ( | const char * | objspec, | |
| SIM_ConstObjectArray & | objects, | |||
| const SIM_Time & | t | |||
| ) | const |
Get all objects that match a particular string. This calls the SIM_Engine::findAllObjectsFromString() function, but converts the time value from global time to simulation time, and passes our getInterpolateData() value as the interpolate parameter.
| void DOP_Parent::findAllRelationshipsFromString | ( | const char * | relspec, | |
| SIM_ConstDataArray & | relationships, | |||
| const SIM_Time & | t | |||
| ) | const |
Get all relationships that match a particular string. This calls the SIM_Engine::findAllRelationshipsFromString() function, but converts the time value from global time to simulation time, and passes our getInterpolateData() value as the interpolate parameter.
| const SIM_Object* DOP_Parent::findObjectFromString | ( | const char * | objspec, | |
| int | whichmatch, | |||
| int * | nummatch, | |||
| const SIM_Time & | t | |||
| ) | const |
Get the object that matches a particular string. This calls the SIM_Engine::findObjectFromString() function, but converts the time value from global time to simulation time, and passes our getInterpolateData() value as the interpolate parameter.
- Examples:
- ROP/ROP_DopField.C.
| const SIM_Relationship* DOP_Parent::findRelationshipFromString | ( | const char * | relspec, | |
| int | whichmatch, | |||
| int * | nummatch, | |||
| const SIM_Time & | t | |||
| ) | const |
Get the relationship that matches a particular string. This calls the SIM_Engine::findRelationshipFromString() function, but converts the time value from global time to simulation time, and passes our getInterpolateData() value as the interpolate parameter.
| static const DOP_ParentList& DOP_Parent::getAllDopParents | ( | ) | [static] |
This static function returns an array of all DOP_Parents.
| bool DOP_Parent::getAutoResimulation | ( | ) | const |
| DOP_Node::DOP_CookData& DOP_Parent::getDopNodeCookData | ( | ) |
Returns data used by DOP_Nodes during their cook process. This is information that is global to the DOP Network as it cooks.
Returns the simulation time that corresponds to a given global Houdini time.
| const DOP_Engine& DOP_Parent::getEngine | ( | ) | const |
| virtual const DOP_Engine& DOP_Parent::getEngineSubclass | ( | ) | const [protected, pure virtual] |
Implemented in OBJ_DopNet.
Returns the global Houdini time that corresponds to a given simulation time.
| bool DOP_Parent::getInterpolateData | ( | const SIM_Time & | t | ) | const |
| bool DOP_Parent::getIsSimulating | ( | ) | const |
| virtual bool DOP_Parent::getIsTimeless | ( | ) | const [inline, virtual] |
| const SIM_Time& DOP_Parent::getLastSetTime | ( | ) | const [protected] |
| static OP_Node* DOP_Parent::getMostRecentDopOwner | ( | ) | [static] |
The current dopnet may not be the top of the recently used. Dopnets that are inside locked assets, for example, are rather useless as destinations.
| bool DOP_Parent::getNeedsResimulation | ( | ) | const |
Returns true if the DOP network has changed such that the simulation needs to be reset.
| DOP_Engine& DOP_Parent::getNonConstEngine | ( | ) |
| virtual DOP_Engine& DOP_Parent::getNonConstEngineSubclass | ( | ) | [protected, pure virtual] |
Implemented in OBJ_DopNet.
| const SIM_Time& DOP_Parent::getOffsetTime | ( | ) | const |
Attributes for controlling the simulation behavior.
| fpreal DOP_Parent::getTimeScale | ( | ) | const |
| void DOP_Parent::notifySimulationChangeSinksOfChange | ( | ) | [protected] |
| void DOP_Parent::notifySimulationChangeSinksOfDelete | ( | ) | [protected] |
| void DOP_Parent::resimulate | ( | ) |
| void DOP_Parent::resimulateLastTimestep | ( | ) | [protected] |
| virtual void DOP_Parent::resimulateLastTimestepSubclass | ( | ) | [protected, virtual] |
| void DOP_Parent::resimulateToTime | ( | const SIM_Time & | t | ) |
Resets the simulation and cooks to a specific DOP time, this avoids double cooking if you are resetting to frame 0.
| void DOP_Parent::sendResimulateNotification | ( | bool | callnotify, | |
| bool | changingguideparm | |||
| ) |
Sends out a parm changed message so that anyone interested in the simulation will know to refresh their data. This call also protects the DOP Network from causing infinite recursion when the DOP Network is interested in a SOP node which is interested in the DOP Network (a common and legal situation when using a SOP Solver, for example).
| void DOP_Parent::setAutoResimulation | ( | bool | autoreset | ) |
| void DOP_Parent::setDOPTime | ( | const SIM_Time & | t | ) |
Sets the current simulation time, solving all intermediate steps. Note that the time t passed in to this function is a global Houdini time, and may not match the simulation time.
| virtual void DOP_Parent::setDOPTimeSubclass | ( | const SIM_Time & | t | ) | [protected, virtual] |
Reimplemented in OBJ_DopNet.
| void DOP_Parent::setInterpolateData | ( | bool | interpolate | ) |
| void DOP_Parent::setIsSimulating | ( | bool | val | ) | [inline] |
Used by SIM_Engine to flag this privately if it is during an internally generated simulation pass
Definition at line 84 of file DOP_Parent.h.
| static void DOP_Parent::setMostRecentDopParent | ( | DOP_Parent * | dopparent | ) | [static] |
This function moves a particular DOP_Parent to the front of the list of all DOP_Parents. This lets us treat this list as a "most recently used" stack.
| void DOP_Parent::setNeedsToFilterData | ( | const SIM_Time & | t | ) | [protected] |
Sets a flag that says we need to re-filter our simulation data the next time a request for the data is made.
| void DOP_Parent::setNeedsToFilterData | ( | ) |
| void DOP_Parent::setNeedsToResimulateLastTimestep | ( | ) |
| void DOP_Parent::setOffsetTime | ( | const SIM_Time & | t | ) |
| void DOP_Parent::setTimeScale | ( | fpreal | scale | ) |
| DEP_MicroNode& DOP_Parent::simMicroNode | ( | ) | [inline] |
Definition at line 130 of file DOP_Parent.h.
Friends And Related Function Documentation
friend class DOP_SimulationChangeSink [friend] |
Definition at line 183 of file DOP_Parent.h.
The documentation for this class was generated from the following file:
- DOP/DOP_Parent.h
