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

This implements a SIM_Geometry that copies the source geometry. More...

#include <SIM_GeometryCopy.h>

+ Inheritance diagram for SIM_GeometryCopy:

Public Member Functions

GU_DetailHandle lockGeometry ()
 
void releaseGeometry (SIM_DataIdStrategy strategy=SIM_DATA_ID_BUMP)
 
GU_DetailHandle swapGeometry (GU_DetailHandle replacement)
 Swaps the internal geometry with the provided one. More...
 
GU_DetailHandle swapGeometryWithoutCEFlush (GU_DetailHandle replacement, bool &hascedata)
 
UT_DMatrix4lockTransform ()
 
void releaseTransform ()
 
virtual GA_CEAttributegetWriteableCEAttribute (GA_AttributeOwner owner, const UT_StringRef &name, GA_StorageClass storage, int &tuplesize, bool isarray, bool docopy)
 
virtual void flushCEWriteCaches () const
 Clear any pending writes from the GPU. More...
 
- Public Member Functions inherited from SIM_Geometry
 GETSET_DATA_FUNCS_S (SIM_NAME_POSITIONPATH, PositionPath)
 
GU_ConstDetailHandle getGeometry () const
 
void getTransform (UT_DMatrix4 &xform) const
 
virtual GA_CEAttributegetReadableCEAttribute (GA_AttributeOwner owner, const UT_StringRef &aname, GA_StorageClass storage, int &tuplesize, bool isarray, bool docopy) const
 
GU_ConstDetailHandle getGeometryWithoutCEFlush () const
 
virtual void flushCECaches () const
 Clear all GPU caches. More...
 
void markCECacheStatus (bool status)
 
void setOwnGeometry (GU_Detail *gdp)
 
void setOwnGeometry (const GU_DetailHandle &gdh)
 
virtual void setOwnGeometrySubclass (const GU_DetailHandle &gdh)
 
GU_ConstDetailHandle getOwnGeometry () const
 Returns a const pointer to our internal geometry data, if it is set. More...
 
GU_DetailHandle getOwnGeometry ()
 Returns a pointer to our internal geometry data, if it is set. More...
 
void setOwnTransform (UT_DMatrix4 *xform)
 
const UT_DMatrix4getOwnTransform () const
 Returns a const pointer to our internal transform data, if it is set. More...
 
UT_DMatrix4getOwnTransform ()
 Returns a pointer to our internal transform data, if it is set. More...
 
- Public Member Functions inherited from SIM_Data
const UT_StringgetDataType () 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
 
bool loadFromFile (const char *filename)
 
bool loadFromStream (UT_IStream &is, bool skiptype=false)
 
bool getIsOfType (const char *datatype) const
 
const voidgetConstPointerToType (const char *datatype) const
 
voidgetPointerToType (const char *datatype)
 
int getNumSubData () const
 Get the number of sub-data items attached to this data. More...
 
const char * getSubDataName (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
 
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...
 
POP_NodegetPOPNode (const char *path, bool addinterest) const
 Given a path relative to our creator node, return a POP_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...
 
- Public Member Functions inherited from SIM_OptionsUser
 SIM_OptionsUser (SIM_Data *owner)
 
virtual ~SIM_OptionsUser ()
 
void optionChanged (const char *name)
 
const SIM_OptionsgetOptions () const
 

Protected Member Functions

 SIM_GeometryCopy (const SIM_DataFactory *factory)
 
virtual ~SIM_GeometryCopy ()
 
virtual void initializeSubclass ()
 Initializes this data by clearing our internal geometry and transform. More...
 
virtual void makeEqualSubclass (const SIM_Data *source)
 
virtual void setParametersSubclass (const SIM_Options &options)
 
- Protected Member Functions inherited from SIM_Geometry
 SIM_Geometry (const SIM_DataFactory *factory)
 
virtual ~SIM_Geometry ()
 
virtual void saveSubclass (std::ostream &os) const
 Saves our attributes, and our internal data if it has been set. More...
 
virtual void saveIOSubclass (std::ostream &os, SIM_DataThreadedIO *io) const
 
virtual bool loadSubclass (UT_IStream &is)
 Loads our attributes and internal data if it was set when we saved. More...
 
virtual bool loadIOSubclass (UT_IStream &is, SIM_DataThreadedIO *io)
 
virtual SIM_QuerycreateQueryObjectSubclass () const
 
virtual void interpolateSubclass (const SIM_Data *source1, const SIM_Data *source2, fpreal interp)
 
virtual int64 getMemorySizeSubclass () const
 
virtual GU_ConstDetailHandle getGeometrySubclass () const
 
virtual void getTransformSubclass (UT_DMatrix4 &xform) 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 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 setNamedSubDataSubclass (const char *dataname, const SIM_Data *data)
 
virtual void removeNamedSubDataSubclass (const char *dataname)
 
virtual void handleModificationSubclass (int code)
 
virtual bool getIsAlternateRepresentationSubclass () const
 
virtual void initAlternateRepresentationSubclass (const SIM_Data &)
 
virtual voidgetCastToType (const char *datatype) const
 
virtual const UT_StringgetDataTypeSubclass () const
 
const SIM_DatagetAlternateRepresentationOf () const
 
- Protected Member Functions inherited from SIM_OptionsUser
SIM_OptionsgetOptions ()
 
virtual void optionChangedSubclass (const char *name)
 

Additional Inherited Members

- 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 char *datatype)
 
static voidcastPointerToType (SIM_Data *data, const char *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 &)
 
- Protected Attributes inherited from SIM_Geometry
bool myHasCECache
 

Detailed Description

This implements a SIM_Geometry that copies the source geometry.

Examples:
SIM/SIM_RadialEmit.C, SIM/SIM_SolverHair.C, and SIM/SIM_SolverHair.h.

Definition at line 27 of file SIM_GeometryCopy.h.

Constructor & Destructor Documentation

SIM_GeometryCopy::SIM_GeometryCopy ( const SIM_DataFactory factory)
explicitprotected
virtual SIM_GeometryCopy::~SIM_GeometryCopy ( )
protectedvirtual

Member Function Documentation

virtual void SIM_GeometryCopy::flushCEWriteCaches ( ) const
virtual

Clear any pending writes from the GPU.

Reimplemented from SIM_Geometry.

virtual GA_CEAttribute* SIM_GeometryCopy::getWriteableCEAttribute ( GA_AttributeOwner  owner,
const UT_StringRef name,
GA_StorageClass  storage,
int tuplesize,
bool  isarray,
bool  docopy 
)
virtual

Build a GPU backed version of the attribute that is marked to be written back to the GU_Detail after computation completes.

virtual void SIM_GeometryCopy::initializeSubclass ( )
protectedvirtual

Initializes this data by clearing our internal geometry and transform.

Reimplemented from SIM_Geometry.

Reimplemented in SIM_PopGeometry.

GU_DetailHandle SIM_GeometryCopy::lockGeometry ( )

This method provides access to the internal geometry so that it can be modified. For each call to lockGeometry(), there must be a corresponding call to releaseGeometry(). Calls to lockGeomtry() can be nested.

UT_DMatrix4& SIM_GeometryCopy::lockTransform ( )

This method provides access to the internal transform so that it can be modified. For each call to lockTransform(), there must be a corresponding call to releaseTransform(). Calls to lockTransform() can be nested.

virtual void SIM_GeometryCopy::makeEqualSubclass ( const SIM_Data source)
protectedvirtual

This function creates an internal copy of any SIM_Geometry data passed to it.

Reimplemented from SIM_Geometry.

Reimplemented in SIM_PopGeometry.

void SIM_GeometryCopy::releaseGeometry ( SIM_DataIdStrategy  strategy = SIM_DATA_ID_BUMP)

This function releases the lock on our internal geometry. This function must be called once for each call to lockGeometry(). Also, once this function has been called, no more modifications should be made to the geometry returned by lockGeometry() or the result will be undefined.

void SIM_GeometryCopy::releaseTransform ( )

This function releases the lock on our internal transform. This function must be called once for each call to lockTransform(). Also, once this function has been called, no more modifications should be made to the transform returned by lockTransform() or the result will be undefined.

virtual void SIM_GeometryCopy::setParametersSubclass ( const SIM_Options options)
protectedvirtual

Respond to setting our parameters by adjusting our transform. The parameters will be in the standard t, r, s style which we convert in to a matrix and multiply by our current transform.

Reimplemented from SIM_Data.

GU_DetailHandle SIM_GeometryCopy::swapGeometry ( GU_DetailHandle  replacement)

Swaps the internal geometry with the provided one.

GU_DetailHandle SIM_GeometryCopy::swapGeometryWithoutCEFlush ( GU_DetailHandle  replacement,
bool &  hascedata 
)

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