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

#include <SNOW_Solver.h>

+ Inheritance diagram for HDK_Sample::SNOW_VoxelArray:

Public Member Functions

 GETSET_DATA_FUNCS_V3 (SNOW_NAME_DIVISIONS, Divisions)
 
 GETSET_DATA_FUNCS_V3 (SNOW_NAME_SIZE, Size)
 
 GETSET_DATA_FUNCS_V3 (SNOW_NAME_CENTER, Center)
 
u8 getVoxel (int x, int y, int z) const
 
void setVoxel (u8 voxel, int x, int y, int z)
 
void collapseAllTiles ()
 
void pubHandleModification ()
 
- 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
 
GA_CEAttributegetReadableCEAttribute (GA_AttributeOwner owner, const UT_StringRef &aname, GA_StorageClass storage, int &tuplesize, bool isarray, bool docopy) const
 
virtual GA_CEAttributegetReadableCEAttributePrec (GA_AttributeOwner owner, const UT_StringRef &aname, GA_StorageClass storage, GA_Precision prec, int &tuplesize, bool isarray, bool docopy) const
 
GU_ConstDetailHandle getGeometryWithoutCEFlush () const
 
GA_Size getNumPoints () const
 
GA_Size getNumPrimitives () const
 
virtual void flushCEWriteCaches () const
 Clear any pending writes from the GPU. More...
 
virtual void flushCECaches () const
 Clear all GPU caches. More...
 
void markCECacheStatus (bool status) const
 
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 makeOwnGeometryUnique ()
 
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_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
 

Protected Member Functions

 SNOW_VoxelArray (const SIM_DataFactory *factory)
 
 ~SNOW_VoxelArray () override
 
void initializeSubclass () override
 Set initial values on all the geometry attributes. More...
 
void makeEqualSubclass (const SIM_Data *source) override
 Makes this geometry equal to some other SIM_Geometry. More...
 
void saveIOSubclass (std::ostream &os, SIM_DataThreadedIO *io) const override
 
bool loadIOSubclass (UT_IStream &is, SIM_DataThreadedIO *io) override
 
void handleModificationSubclass (int code) override
 
int64 getMemorySizeSubclass () const override
 
void optionChangedSubclass (const char *name) override
 
GU_ConstDetailHandle getGeometrySubclass () const override
 
- Protected Member Functions inherited from SIM_Geometry
 SIM_Geometry (const SIM_DataFactory *factory)
 
 ~SIM_Geometry () override
 
void saveSubclass (std::ostream &os) const override
 Saves our attributes, and our internal data if it has been set. More...
 
bool loadSubclass (UT_IStream &is) override
 Loads our attributes and internal data if it was set when we saved. More...
 
SIM_QuerycreateQueryObjectSubclass () const override
 
void interpolateSubclass (const SIM_Data *source1, const SIM_Data *source2, fpreal interp) override
 
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 setParametersSubclass (const SIM_Options &parms)
 
virtual void setNamedSubDataSubclass (const char *dataname, const SIM_Data *data)
 
virtual void removeNamedSubDataSubclass (const char *dataname)
 
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 ()
 

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 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 &)
 
- Protected Attributes inherited from SIM_Geometry
bool myHasCECache
 

Detailed Description

Examples:
SIM/SNOW_Solver.C.

Definition at line 135 of file SNOW_Solver.h.

Constructor & Destructor Documentation

SNOW_VoxelArray::SNOW_VoxelArray ( const SIM_DataFactory factory)
explicitprotected
Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 615 of file SNOW_Solver.C.

SNOW_VoxelArray::~SNOW_VoxelArray ( )
overrideprotected
Examples:
SIM/SNOW_Solver.h.

Definition at line 621 of file SNOW_Solver.C.

Member Function Documentation

void SNOW_VoxelArray::collapseAllTiles ( )
Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 1007 of file SNOW_Solver.C.

GU_ConstDetailHandle SNOW_VoxelArray::getGeometrySubclass ( ) const
overrideprotectedvirtual

This function is called by getGeometry() to return the actual geometry data. The default implementation returns an empty geometry.

Reimplemented from SIM_Geometry.

Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 683 of file SNOW_Solver.C.

int64 SNOW_VoxelArray::getMemorySizeSubclass ( ) const
overrideprotectedvirtual

Override this function to return an accurate representation of the amount of memory used by this piece of data. The size of subdata should not be included in this calculation.

Reimplemented from SIM_Geometry.

Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 981 of file SNOW_Solver.C.

HDK_Sample::SNOW_VoxelArray::GETSET_DATA_FUNCS_V3 ( SNOW_NAME_DIVISIONS  ,
Divisions   
)
Examples:
SIM/SNOW_Solver.h.
HDK_Sample::SNOW_VoxelArray::GETSET_DATA_FUNCS_V3 ( SNOW_NAME_SIZE  ,
Size   
)
HDK_Sample::SNOW_VoxelArray::GETSET_DATA_FUNCS_V3 ( SNOW_NAME_CENTER  ,
Center   
)
u8 SNOW_VoxelArray::getVoxel ( int  x,
int  y,
int  z 
) const
Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 664 of file SNOW_Solver.C.

void SNOW_VoxelArray::handleModificationSubclass ( int  code)
overrideprotectedvirtual

Override this method to customize the behavior when our internal data changes. The code parameter is a data type specific value which can be used to indicate the type of change that has occurred. The default implementation deletes all subdata that was created with the deleteifmodified flag turned on. Remember to call the base class implementation.

Reimplemented from SIM_Data.

Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 998 of file SNOW_Solver.C.

void SNOW_VoxelArray::initializeSubclass ( )
overrideprotectedvirtual

Set initial values on all the geometry attributes.

Reimplemented from SIM_Geometry.

Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 868 of file SNOW_Solver.C.

bool SNOW_VoxelArray::loadIOSubclass ( UT_IStream is,
SIM_DataThreadedIO io 
)
overrideprotectedvirtual

Loading variant that allows you to request loading data at the end of the .sim file that was saved with saveIOSubclass If not overloaded, passes through to loadSubclass. If io is NULL, shoudl not attempt threaded loading.

Reimplemented from SIM_Geometry.

Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 929 of file SNOW_Solver.C.

void SNOW_VoxelArray::makeEqualSubclass ( const SIM_Data source)
overrideprotectedvirtual

Makes this geometry equal to some other SIM_Geometry.

Reimplemented from SIM_Geometry.

Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 876 of file SNOW_Solver.C.

void SNOW_VoxelArray::optionChangedSubclass ( const char *  name)
overrideprotectedvirtual

Invoked when our parameters are changed, we use it to invalidate our array.

Reimplemented from SIM_OptionsUser.

Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 651 of file SNOW_Solver.C.

void HDK_Sample::SNOW_VoxelArray::pubHandleModification ( )
inline
Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 150 of file SNOW_Solver.h.

void SNOW_VoxelArray::saveIOSubclass ( std::ostream &  os,
SIM_DataThreadedIO io 
) const
overrideprotectedvirtual

Save variant that allows you to delay part of your saving to a background thread. If not overloaded, passes through to saveSubclass. If io is NULL, shoudl not attempt threaded loading.

Reimplemented from SIM_Geometry.

Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 902 of file SNOW_Solver.C.

void SNOW_VoxelArray::setVoxel ( u8  voxel,
int  x,
int  y,
int  z 
)
Examples:
SIM/SNOW_Solver.C, and SIM/SNOW_Solver.h.

Definition at line 673 of file SNOW_Solver.C.


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