HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SIM_SolverSop Class Reference

#include <SIM_SolverSop.h>

+ Inheritance diagram for SIM_SolverSop:

Public Member Functions

 GETSET_DATA_FUNCS_B ("usesoppath", UseSopPath)
 
 GETSET_DATA_FUNCS_S (SIM_NAME_SOPPATH, SopPath)
 
 GETSET_DATA_FUNCS_S (SIM_NAME_DATAPATH, DataPath)
 
 GETSET_DATA_FUNCS_S ("primaryinputname", PrimaryInputName)
 
 GETSET_DATA_FUNCS_B ("doinvoke", DoInvoke)
 
 GETSET_DATA_FUNCS_I ("numinputs", NumInputs)
 
 GET_DATA_FUNC_I ("numstamps", NumStamps)
 
void getStampVariable (UT_String &value, int n) const
 
fpreal getStampValueF (int n) const
 
void getStampValueS (UT_String &value, int n) const
 
bool stampIsFloat (int n) const
 
void getInputName (UT_String &value, int inputno) const
 
exint getInputSource (int inputno) const
 
void getInputDataName (UT_String &value, int inputno) const
 
void getInputObjectName (UT_String &value, int inputno) const
 
void getInputRelationship (UT_String &value, int inputno) const
 
void getInputColliderLabel (UT_String &value, int inputno) const
 
exint getInputTimeMode (int inputno) const
 
 GETSET_DATA_FUNCS_I ("numoutputs", NumOutputs)
 
void getOutputName (UT_String &value, int inputno) const
 
void getOutputDataName (UT_String &value, int inputno) const
 
void getOutputSopPath (UT_String &value, int inputno) const
 
 GETSET_DATA_FUNCS_B (SIM_NAME_TRANSFORMSOPOUTPUT, TransformSopOutput)
 
 GETSET_DATA_FUNCS_B (SIM_NAME_SOLVEINITFRAME, SolveInitFrame)
 
 GETSET_DATA_FUNCS_B ("usetimestep", UseTimeStep)
 
 GETSET_DATA_FUNCS_F ("timescale", TimeScale)
 
- Public Member Functions inherited from SIM_SingleSolver
SIM_Result solveSingleObject (SIM_Engine &engine, SIM_Object &object, SIM_ObjectArray &feedbacktoobjects, const SIM_Time &timestep, bool newobject)
 
- Public Member Functions inherited from SIM_Solver
SIM_Result solveObjects (SIM_Engine &engine, SIM_ObjectArray &objects, SIM_ObjectArray &newobjects, SIM_ObjectArray &feedbacktoobjects, const SIM_Time &timestep)
 
SIM_Result postSolveObjects (SIM_Engine &engine, SIM_ObjectArray &objects, SIM_ObjectArray &newobjects, SIM_ObjectArray &feedbacktoobjects, const SIM_Time &timestep)
 
SIM_Result solveRelationship (SIM_Engine &engine, SIM_Relationship &relationship, const SIM_Time &timestep)
 
int getRequestedCache () const
 
void getImpulseMassMatrix (const SIM_Object &object, const UT_Vector3 &impulseworldpos, UT_DMatrix3 &immatrix) const
 
void getPointImpulseMassMatrix (const SIM_Object &object, GA_Index ptnum, UT_DMatrix3 &immatrix) const
 
SIM_PointImpulseMassMatrixResolvergetPointImpulseMassMatrixResolver (const SIM_Object &object) const
 Builds a resolver to efficiently compute mass matrices. More...
 
fpreal getPropertyAtPosition (const SIM_Object &object, const UT_Vector3 &worldpos, const SIM_Property &property) const
 
fpreal getPropertyAtPoint (const SIM_Object &object, GA_Index ptnum, const SIM_Property &property) const
 
SIM_PropertyResolvergetPropertyResolver (const SIM_Object &object, const SIM_Property &property) const
 Builds a resolver to efficiently compute property values. More...
 
void getDefaultColliderLabel (const SIM_Object &object, UT_String &label) const
 Gets the default collider label for an object using this solver. More...
 
void getDefaultCollider (const SIM_Object &object, const UT_String &colliderlabel, UT_String &collidertype, bool &colliderreverseobjectroles) const
 
void setStartTime (const SIM_Time &starttime)
 
bool isStatic (const SIM_Object *obj) const
 
- Public Member Functions inherited from SIM_Data
const UT_StringHoldergetDataType () const
 
void initialize (const SIM_SubdataBehavior &subdatabehavior)
 
void makeEqual (const SIM_Data *source, const SIM_SubdataBehavior &subdatabehavior)
 
void setParameters (const SIM_Options &parms)
 
void interpolate (const SIM_Data *source1, const SIM_Data *source2, fpreal interp)
 
int64 getMemorySize () const
 
bool getIsAlternateRepresentation () const
 
bool saveToFile (const char *filename, UT_CompressionType compressionType) const
 
bool saveToStream (std::ostream &os, UT_CompressionType compressionType) const
 
void appendFullDataPath (const SIM_Data *subdata, bool useobjectid, UT_String &datapath) const
 
bool loadFromFile (const char *filename)
 
bool loadFromStream (UT_IStream &is, bool skiptype=false)
 
bool getIsOfType (const UT_StringRef &datatype) const
 
const voidgetConstPointerToType (const UT_StringRef &datatype) const
 
voidgetPointerToType (const UT_StringRef &datatype)
 
int getNumSubData () const
 Get the number of sub-data items attached to this data. More...
 
const UT_StringHoldergetSubDataName (int index) const
 Get the name of the sub-data at a particular index location. More...
 
int getSubDataIndex (const SIM_Data *subdata) const
 
bool buildSubDataPath (const SIM_Data *subdata, UT_String &pathto) const
 
const SIM_QuerygetQueryObject () const
 
SIM_OptionsgetUserOptions ()
 
const SIM_OptionsgetConstUserOptions () const
 
long getGuideParmVersion () const
 
void addGuideDep (DEP_MicroNode &src) const
 
virtual bool getGuideGeometryList (const SIM_RootData &root, const char *datapath, const SIM_Time &t, UT_Array< GU_ConstDetailHandle > &detailArray, UT_Array< UT_DMatrix4 > &xformArray) const
 
GU_ConstDetailHandle getGuideGeometry (const SIM_RootData &root, const char *datapath, UT_DMatrix4 &xform, const SIM_Time &t) const
 
void buildGuideOptions (SIM_Options &options, const SIM_Time &time) const
 
SIM_DatagetSubData (int index)
 
const SIM_DatagetConstSubData (int index) const
 
SIM_DatagetNamedSubData (const char *dataname)
 
const SIM_DatagetConstNamedSubData (const char *dataname) const
 
void filterSubData (SIM_DataArray &ncdp, UT_StringArray *names, const SIM_DataFilter &ncfilter, const char *startfrom, const SIM_DataFilter &recursefilter)
 
void filterConstSubData (SIM_ConstDataArray &dp, UT_StringArray *names, const SIM_DataFilter &filter, const char *startfrom, const SIM_DataFilter &recurseFilter) const
 
SIM_DatagetNthSubData (UT_String *name, const SIM_DataFilter &filter, int n, const char *startfrom, const SIM_DataFilter &recurseFilter)
 
const SIM_DatagetNthConstSubData (UT_String *name, const SIM_DataFilter &filter, int n, const char *startfrom, const SIM_DataFilter &recurseFilter) const
 
void forEachSubData (SIM_EachDataCallback &cb, const SIM_DataFilter &filter, const char *startfrom, const SIM_DataFilter &recurseFilter)
 
void forEachConstSubData (SIM_EachDataCallback &cb, const SIM_DataFilter &filter, const char *startfrom, const SIM_DataFilter &recurseFilter) const
 
SIM_DatacreateNamedSubData (const char *dataname, const char *datatype, int creationflags, UT_String *newdatanameptr=NULL)
 
SIM_DatagetOrCreateAlternateRepresentation (const char *dataname, const char *datatype) const
 
void interpolateSubData (const SIM_Data &source1, const SIM_Data &source2, fpreal interp, const SIM_DataFilter &interpdata, const SIM_DataFilter &recurse)
 
void setNamedSubData (const char *dataname, const SIM_Data *data, int setflags)
 
void createUniqueSubDataName (const SIM_Data *subdata, UT_String &dataname) const
 
void removeNamedSubData (const char *dataname)
 Remove some existing sub-data by name. More...
 
void removeSubData (int index)
 Remove some existing sub-data by index. More...
 
void moveNamedSubData (const char *oldname, const char *newname)
 
const UT_GuidgetUniqueId () const
 
long getReferenceCount () const
 
int getCreatorId () const
 Get the ID of the node that created this data. More...
 
OP_NodegetCreatorNode () const
 Use the creator ID to look up the OP_Node that created this data. More...
 
OP_NodegetOwnerNetwork () const
 Look up the owner node of our engine to get the DOP Network pointer. More...
 
const SIM_EnginegetEngine () const
 Get the engine that created us (from our data factory). More...
 
int getCreatorIndex () const
 Get the output index of the creator node that generated this data. More...
 
const SIM_TimegetCreationTime () const
 Get the creation time for this data. More...
 
bool getIsSelected () const
 Get the selected flag for this data. More...
 
void setIsSelected (bool selected) const
 
bool getSelectionRepresentsObject () const
 
void copyCreationInfoFrom (const SIM_Data *source)
 
OP_NodegetNodePathsRelativeTo () const
 
OP_NodegetOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return an OBJ_Node. More...
 
OBJ_NodegetOBJNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return an OBJ_Node. More...
 
SOP_NodegetSOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a SOP_Node. More...
 
DOP_NodegetDOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a DOP_Node. More...
 
COP2_NodegetCOP2Node (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a COP2_Node. More...
 
CHOP_NodegetCHOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a CHOP_Node. More...
 
void addOPInterest (OP_Node *node) const
 Adds an interest in the specified node to our engine's owner node. More...
 
void addError (const SIM_RootData *root, int errorcode, const char *errorparm, UT_ErrorSeverity severity) const
 Adds an error to our SIM_Engine. More...
 
void makeMemberDataUnique ()
 
virtual void makeMemberDataUniqueSubclass ()
 
- Public Member Functions inherited from SIM_OptionsUser
 SIM_OptionsUser (SIM_Data *owner)
 
virtual ~SIM_OptionsUser ()
 
void optionChanged (const char *name)
 
const SIM_OptionsgetOptions () const
 

Static Public Attributes

static PRM_Template myTemplateList []
 
static PRM_Template myTemplateList2 []
 

Protected Member Functions

 SIM_SolverSop (const SIM_DataFactory *factory)
 
 ~SIM_SolverSop () override
 
void makeEqualSubclass (const SIM_Data *source) override
 myCompiled aware copy constructor. More...
 
SIM_Result solveSingleObjectSubclass (SIM_Engine &engine, SIM_Object &object, SIM_ObjectArray &feedbacktoobjects, const SIM_Time &timestep, bool newobject) override
 
SIM_Result solveRelationshipSubclass (SIM_Engine &engine, SIM_Relationship &relation, const SIM_Time &timestep) override
 
- Protected Member Functions inherited from SIM_SingleSolver
 SIM_SingleSolver (const SIM_DataFactory *factory)
 Basic SIM_SingleSolver constructor. More...
 
 ~SIM_SingleSolver () override
 Basic SIM_SingleSolver destructor. More...
 
SIM_Result solveObjectsSubclass (SIM_Engine &engine, SIM_ObjectArray &objects, SIM_ObjectArray &newobjects, SIM_ObjectArray &feedbacktoobjects, const SIM_Time &timestep) override
 Override this method to call solveSingleObject(). More...
 
- Protected Member Functions inherited from SIM_Solver
 SIM_Solver (const SIM_DataFactory *factory)
 Basic SIM_Solver constructor. More...
 
 ~SIM_Solver () override
 Basic SIM_Solver destructor. More...
 
bool getStartTime (SIM_Time &time)
 
void clearStartTime ()
 
void getSolverSubdata (SIM_SolverArray &subsolvers, UT_StringArray *subsolvernames)
 
void getConstSolverSubdata (SIM_ConstSolverArray &subsolvers, UT_StringArray *subsolvernames) const
 
virtual bool isStaticSubclass (const SIM_Object *obj) const
 Determines if this solver does nothing on the object. More...
 
virtual SIM_Result postSolveObjectsSubclass (SIM_Engine &engine, SIM_ObjectArray &objects, SIM_ObjectArray &newobjects, SIM_ObjectArray &feedbacktoobjects, const SIM_Time &timestep)
 
virtual int getRequestedCacheSubclass () const
 
virtual void getImpulseMassMatrixSubclass (const SIM_Object &object, const UT_Vector3 &impulseworldpos, UT_DMatrix3 &immatrix) const
 
virtual void getPointImpulseMassMatrixSubclass (const SIM_Object &object, int ptnum, UT_DMatrix3 &immatrix) const
 
virtual
SIM_PointImpulseMassMatrixResolver
getPointImpulseMassMatrixResolverSubclass (const SIM_Object &object) const
 Builds a resolver for evaluating mass matrices swiftly. More...
 
virtual fpreal getPropertyAtPositionSubclass (const SIM_Object &object, const UT_Vector3 &worldpos, const SIM_Property &property) const
 
virtual fpreal getPropertyAtPointSubclass (const SIM_Object &object, int ptnum, const SIM_Property &property) const
 
virtual SIM_PropertyResolvergetPropertyResolverSubclass (const SIM_Object &object, const SIM_Property &property) const
 Builds a resolver for evaluating properties swiftly. More...
 
virtual void getDefaultColliderLabelSubclass (const SIM_Object &object, UT_String &label) const
 Gets the default collider label for an object using this solver. More...
 
virtual void getDefaultColliderSubclass (const SIM_Object &object, const UT_String &colliderlabel, UT_String &collidertype, bool &colliderreverseobjectroles) const
 
- Protected Member Functions inherited from SIM_Data
 SIM_Data (const SIM_DataFactory *factory)
 
virtual ~SIM_Data ()
 
void handleModification (int code=-1)
 
void setNeedsToRecalculateMemorySize () const
 
void deleteQueryObjectIfNotBuilding () const
 Deletes the query object for this data, if there is one. More...
 
void deleteGuideObjectIfNotBuilding () const
 Delete the guide geometry for this data, if it exists. More...
 
void initAlternateRepresentation () const
 
void setNeedsInitialization (bool needsinit) const
 Flags an alternate representation subdata as requiring initialization. More...
 
bool getNeedsInitialization () const
 Tests whether an alternate representation requires initialization. More...
 
bool saveOptionPacket (std::ostream &os, const char *name, const SIM_Options *opts) const
 
bool loadOptionPacket (UT_IStream &is, const char *name, SIM_Options *opts) const
 
bool getIsDoingSimplifiedSaveLoad () const
 
void initializeFromParmDefaults ()
 
void setSelectionRepresentsObject (bool representsobject)
 
virtual void setNeedsInitializationSubclass (bool needsinit) const
 
virtual void initializeSubclass ()
 
virtual void saveSubclass (std::ostream &os) const
 
virtual void saveIOSubclass (std::ostream &os, SIM_DataThreadedIO *io) const
 
virtual bool loadSubclass (UT_IStream &is)
 
virtual bool loadIOSubclass (UT_IStream &is, SIM_DataThreadedIO *io)
 
virtual SIM_QuerycreateQueryObjectSubclass () const
 
virtual long getGuideParmVersionSubclass () const
 
virtual SIM_GuidecreateGuideObjectSubclass () const
 
virtual void buildGuideGeometrySubclass (const SIM_RootData &root, const SIM_Options &options, const GU_DetailHandle &gdh, UT_DMatrix4 *xform, const SIM_Time &t) const
 
virtual void setParametersSubclass (const SIM_Options &parms)
 
virtual void setNamedSubDataSubclass (const char *dataname, const SIM_Data *data)
 
virtual void removeNamedSubDataSubclass (const char *dataname)
 
virtual void interpolateSubclass (const SIM_Data *source1, const SIM_Data *source2, fpreal interp)
 
virtual int64 getMemorySizeSubclass () const
 
virtual void handleModificationSubclass (int code)
 
virtual bool getIsAlternateRepresentationSubclass () const
 
virtual void initAlternateRepresentationSubclass (const SIM_Data &)
 
virtual voidgetCastToType (const UT_StringRef &datatype) const
 
virtual const UT_StringHoldergetDataTypeSubclass () const
 
const SIM_DatagetAlternateRepresentationOf () const
 
- Protected Member Functions inherited from SIM_OptionsUser
SIM_OptionsgetOptions ()
 
virtual void optionChangedSubclass (const char *name)
 

Additional Inherited Members

- Public Types inherited from SIM_Solver
enum  SIM_Result { SIM_SOLVER_SUCCESS, SIM_SOLVER_REPEAT, SIM_SOLVER_SUBSTEP, SIM_SOLVER_FAIL }
 
- Static Public Member Functions inherited from SIM_Solver
static const char * getPropertyAttribName (const SIM_Property &property)
 
static fpreal getPropertyAtPositionStatic (const SIM_Object &object, const UT_Vector3 &worldpos, const SIM_Property &property)
 
static fpreal getPropertyAtPointStatic (const SIM_Object &object, GA_Index ptnum, const SIM_Property &property)
 
static SIM_PropertyResolvergetPropertyResolverStatic (const SIM_Object &object, const SIM_Property &property)
 Static resolver for getting property values. More...
 
- Static Public Member Functions inherited from SIM_Data
static bool getDataTypeFromFile (const char *filename, UT_String &datatype)
 
static bool getDataTypeFromStream (UT_IStream &is, UT_String &datatype)
 
static const voidcastConstPointerToType (const SIM_Data *data, const UT_StringRef &datatype)
 
static voidcastPointerToType (SIM_Data *data, const UT_StringRef &datatype)
 
- Static Protected Member Functions inherited from SIM_Data
static const PRM_TemplategetEmptyTemplateList ()
 
static const SIM_DopDescriptiongetEmptyDopDescription ()
 A DOP description that says not to create an automatic DOP. More...
 
static void getDataTypeSuperclasses (UT_StringArray &)
 

Detailed Description

Definition at line 20 of file SIM_SolverSop.h.

Constructor & Destructor Documentation

SIM_SolverSop::SIM_SolverSop ( const SIM_DataFactory factory)
explicitprotected
SIM_SolverSop::~SIM_SolverSop ( )
overrideprotected

Member Function Documentation

SIM_SolverSop::GET_DATA_FUNC_I ( "numstamps"  ,
NumStamps   
)
void SIM_SolverSop::getInputColliderLabel ( UT_String value,
int  inputno 
) const
inline

Definition at line 52 of file SIM_SolverSop.h.

void SIM_SolverSop::getInputDataName ( UT_String value,
int  inputno 
) const
inline

Definition at line 46 of file SIM_SolverSop.h.

void SIM_SolverSop::getInputName ( UT_String value,
int  inputno 
) const
inline

Definition at line 42 of file SIM_SolverSop.h.

void SIM_SolverSop::getInputObjectName ( UT_String value,
int  inputno 
) const
inline

Definition at line 48 of file SIM_SolverSop.h.

void SIM_SolverSop::getInputRelationship ( UT_String value,
int  inputno 
) const
inline

Definition at line 50 of file SIM_SolverSop.h.

exint SIM_SolverSop::getInputSource ( int  inputno) const
inline

Definition at line 44 of file SIM_SolverSop.h.

exint SIM_SolverSop::getInputTimeMode ( int  inputno) const
inline

Definition at line 54 of file SIM_SolverSop.h.

void SIM_SolverSop::getOutputDataName ( UT_String value,
int  inputno 
) const
inline

Definition at line 60 of file SIM_SolverSop.h.

void SIM_SolverSop::getOutputName ( UT_String value,
int  inputno 
) const
inline

Definition at line 58 of file SIM_SolverSop.h.

void SIM_SolverSop::getOutputSopPath ( UT_String value,
int  inputno 
) const
inline

Definition at line 62 of file SIM_SolverSop.h.

SIM_SolverSop::GETSET_DATA_FUNCS_B ( "usesoppath"  ,
UseSopPath   
)
SIM_SolverSop::GETSET_DATA_FUNCS_B ( "doinvoke"  ,
DoInvoke   
)
SIM_SolverSop::GETSET_DATA_FUNCS_B ( SIM_NAME_TRANSFORMSOPOUTPUT  ,
TransformSopOutput   
)
SIM_SolverSop::GETSET_DATA_FUNCS_B ( SIM_NAME_SOLVEINITFRAME  ,
SolveInitFrame   
)
SIM_SolverSop::GETSET_DATA_FUNCS_B ( "usetimestep"  ,
UseTimeStep   
)
SIM_SolverSop::GETSET_DATA_FUNCS_F ( "timescale"  ,
TimeScale   
)
SIM_SolverSop::GETSET_DATA_FUNCS_I ( "numinputs"  ,
NumInputs   
)
SIM_SolverSop::GETSET_DATA_FUNCS_I ( "numoutputs"  ,
NumOutputs   
)
SIM_SolverSop::GETSET_DATA_FUNCS_S ( SIM_NAME_SOPPATH  ,
SopPath   
)
SIM_SolverSop::GETSET_DATA_FUNCS_S ( SIM_NAME_DATAPATH  ,
DataPath   
)
SIM_SolverSop::GETSET_DATA_FUNCS_S ( "primaryinputname"  ,
PrimaryInputName   
)
fpreal SIM_SolverSop::getStampValueF ( int  n) const
inline

Definition at line 35 of file SIM_SolverSop.h.

void SIM_SolverSop::getStampValueS ( UT_String value,
int  n 
) const
inline

Definition at line 37 of file SIM_SolverSop.h.

void SIM_SolverSop::getStampVariable ( UT_String value,
int  n 
) const
inline

Definition at line 33 of file SIM_SolverSop.h.

void SIM_SolverSop::makeEqualSubclass ( const SIM_Data source)
overrideprotectedvirtual

myCompiled aware copy constructor.

Reimplemented from SIM_Data.

SIM_Result SIM_SolverSop::solveRelationshipSubclass ( SIM_Engine engine,
SIM_Relationship relation,
const SIM_Time timestep 
)
overrideprotectedvirtual

Reimplemented from SIM_Solver.

SIM_Result SIM_SolverSop::solveSingleObjectSubclass ( SIM_Engine engine,
SIM_Object object,
SIM_ObjectArray feedbacktoobjects,
const SIM_Time timestep,
bool  newobject 
)
overrideprotectedvirtual

This method is called for each object passed to solveObjectsSubclass().

Implements SIM_SingleSolver.

bool SIM_SolverSop::stampIsFloat ( int  n) const
inline

Definition at line 39 of file SIM_SolverSop.h.

Member Data Documentation

PRM_Template SIM_SolverSop::myTemplateList[]
static

Definition at line 70 of file SIM_SolverSop.h.

PRM_Template SIM_SolverSop::myTemplateList2[]
static

Definition at line 71 of file SIM_SolverSop.h.


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