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

This class holds a three dimensional scalar field. More...

#include <SIM_IndexField.h>

+ Inheritance diagram for SIM_IndexField:

Public Types

typedef SIM_RawIndexField rawfield_type
 

Public Member Functions

 GETSET_DATA_FUNCS_S (SIM_NAME_POSITIONPATH, PositionPath)
 
 GETSET_DATA_FUNCS_I (SIM_NAME_UNIFORMVOXELS, UniformVoxels)
 Control the number of divisions. More...
 
 GETSET_DATA_FUNCS_B (SIM_NAME_TWOD, TwoDField)
 
 GETSET_DATA_FUNCS_I (SIM_NAME_VOXELPLANE, VoxelPlane)
 
 GETSET_DATA_FUNCS_V3 (SIM_NAME_DIV, RawDivisions)
 
 GETSET_DATA_FUNCS_I ("uniformdiv", RawUniformDivisions)
 
 GETSET_DATA_FUNCS_F ("divsize", RawDivisionSize)
 
 GETSET_DATA_FUNCS_V3 (SIM_NAME_CENTER, RawCenter)
 
 GETSET_DATA_FUNCS_V3 (SIM_NAME_SIZE, RawSize)
 
 GETSET_DATA_FUNCS_V3 ("slicediv", SliceDivisions)
 
 GETSET_DATA_FUNCS_V3 ("sliceoverlapneg", SliceOverlapNeg)
 
 GETSET_DATA_FUNCS_V3 ("sliceoverlappos", SliceOverlapPos)
 
exint getNumSlices () const
 
 GETSET_DATA_FUNCS_I ("totalvoxels", TotalVoxels)
 
 GETSET_DATA_FUNCS_V3 ("totalvoxelres", TotalVoxelRes)
 
 GETSET_DATA_FUNCS_I (SIM_NAME_VOXELSAMPLE, VoxelSampleRaw)
 
 GETSET_DATA_FUNCS_I ("initialvalue", InitialValue)
 
 GETSET_DATA_FUNCS_I ("border", RawBorder)
 
UT_VoxelBorderType getBorder () const
 
void setBorder (UT_VoxelBorderType border)
 
void getBBox (UT_BoundingBox &bbox) const
 
UT_Vector3 getOrig () const
 
UT_Vector3 getDivisions () const
 
UT_Vector3 getSize () const
 
UT_Vector3 getCenter () const
 
void setDivisions (const UT_Vector3 &div)
 
void setSize (const UT_Vector3 &div)
 
void setCenter (const UT_Vector3 &div)
 
void resizeKeepData (const UT_Vector3 &size, const UT_Vector3 &center, bool keepdata, const char *address=0, int port=-1)
 
void matchField (const SIM_ScalarField *field)
 
void matchField (const SIM_VectorField *field)
 
void matchField (const SIM_MatrixField *field)
 
void matchField (const SIM_IndexField *field, bool matchsamples=false)
 
SIM_FieldSample getVoxelSample () const
 
const UT_Vector3getVoxelSize () const
 
fpreal getVoxelDiameter () const
 
void setVoxelSize (const UT_Vector3 &voxelsize)
 
exint getValue (const UT_Vector3 &pos) const
 
bool indexToPos (int x, int y, int z, UT_Vector3 &pos) const
 Converts an integer index into a worldspace position. More...
 
bool indexToPos (exint x, exint y, exint z, UT_Vector3D &pos) const
 
bool posToIndex (const UT_Vector3 &pos, int &x, int &y, int &z) const
 Converts a worldspace position into an integer index. More...
 
SIM_RawIndexFieldgetField () const
 Retrieve raw field. More...
 
void setField (SIM_RawIndexField *field)
 Sets the field to the given field, gaining ownership of it. More...
 
bool testForNan () const
 Can't have NANs in integer fields. More...
 
bool appearsToBeUnused () const
 
SIM_RawIndexFieldstealField ()
 
void pubHandleModification ()
 Signals to the field that it has been altered externally. More...
 
void updateTotalVoxels ()
 
GU_ConstDetailHandle createSmokeRepresentation (const SIM_RootData &root) const
 Creates a GDP with us as a Volume Primitive inside it. More...
 
void addSmokeRepresentation (const SIM_RootData &root, GU_Detail *gdp) const
 
- 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_IndexField (const SIM_DataFactory *factory)
 
virtual ~SIM_IndexField ()
 
virtual void initializeSubclass ()
 Overrides to properly implement this class as a SIM_Data. More...
 
virtual void makeEqualSubclass (const SIM_Data *source)
 myField aware copy constructor. More...
 
virtual void saveSubclass (std::ostream &os) const
 Saves our attributes, and our internal data if it has been set. More...
 
virtual bool loadSubclass (UT_IStream &is)
 Loads our attributes and internal data if it was set when we saved. More...
 
virtual exint getMemorySizeSubclass () const
 
virtual void optionChangedSubclass (const char *name)
 Override the setDivisions to rebuild our voxel array on demand. More...
 
- 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 saveIOSubclass (std::ostream &os, SIM_DataThreadedIO *io) const
 
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 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 ()
 

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 &)
 

Detailed Description

This class holds a three dimensional scalar field.

Definition at line 31 of file SIM_IndexField.h.

Member Typedef Documentation

Constructor & Destructor Documentation

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

Member Function Documentation

void SIM_IndexField::addSmokeRepresentation ( const SIM_RootData root,
GU_Detail gdp 
) const

Adds a volume primitive version of our field to the given gdp.

bool SIM_IndexField::appearsToBeUnused ( ) const
inline

True if we have a constant value. Ignores end conditions in determining this. Used as a rough guess that the field is unused.

Definition at line 132 of file SIM_IndexField.h.

GU_ConstDetailHandle SIM_IndexField::createSmokeRepresentation ( const SIM_RootData root) const

Creates a GDP with us as a Volume Primitive inside it.

void SIM_IndexField::getBBox ( UT_BoundingBox bbox) const

Controls the dimensions of where the field is properly defined in the field space.

UT_VoxelBorderType SIM_IndexField::getBorder ( ) const
inline

Definition at line 63 of file SIM_IndexField.h.

UT_Vector3 SIM_IndexField::getCenter ( ) const
UT_Vector3 SIM_IndexField::getDivisions ( ) const

Calculate the size and divisions according to options such as 2d or equal sized voxels.

SIM_RawIndexField* SIM_IndexField::getField ( ) const
inline

Retrieve raw field.

Definition at line 121 of file SIM_IndexField.h.

virtual exint SIM_IndexField::getMemorySizeSubclass ( ) const
protectedvirtual

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_Data.

exint SIM_IndexField::getNumSlices ( ) const
inline

Definition at line 55 of file SIM_IndexField.h.

UT_Vector3 SIM_IndexField::getOrig ( ) const
inline

Definition at line 70 of file SIM_IndexField.h.

SIM_IndexField::GETSET_DATA_FUNCS_B ( SIM_NAME_TWOD  ,
TwoDField   
)
SIM_IndexField::GETSET_DATA_FUNCS_F ( "divsize"  ,
RawDivisionSize   
)
SIM_IndexField::GETSET_DATA_FUNCS_I ( SIM_NAME_UNIFORMVOXELS  ,
UniformVoxels   
)

Control the number of divisions.

SIM_IndexField::GETSET_DATA_FUNCS_I ( SIM_NAME_VOXELPLANE  ,
VoxelPlane   
)
SIM_IndexField::GETSET_DATA_FUNCS_I ( "uniformdiv"  ,
RawUniformDivisions   
)
SIM_IndexField::GETSET_DATA_FUNCS_I ( "totalvoxels"  ,
TotalVoxels   
)
SIM_IndexField::GETSET_DATA_FUNCS_I ( SIM_NAME_VOXELSAMPLE  ,
VoxelSampleRaw   
)
SIM_IndexField::GETSET_DATA_FUNCS_I ( "initialvalue"  ,
InitialValue   
)
SIM_IndexField::GETSET_DATA_FUNCS_I ( "border"  ,
RawBorder   
)
SIM_IndexField::GETSET_DATA_FUNCS_S ( SIM_NAME_POSITIONPATH  ,
PositionPath   
)

Accesses the relative path to the position data associated with this geometry.

SIM_IndexField::GETSET_DATA_FUNCS_V3 ( SIM_NAME_DIV  ,
RawDivisions   
)
SIM_IndexField::GETSET_DATA_FUNCS_V3 ( SIM_NAME_CENTER  ,
RawCenter   
)
SIM_IndexField::GETSET_DATA_FUNCS_V3 ( SIM_NAME_SIZE  ,
RawSize   
)
SIM_IndexField::GETSET_DATA_FUNCS_V3 ( "slicediv"  ,
SliceDivisions   
)
SIM_IndexField::GETSET_DATA_FUNCS_V3 ( "sliceoverlapneg"  ,
SliceOverlapNeg   
)
SIM_IndexField::GETSET_DATA_FUNCS_V3 ( "sliceoverlappos"  ,
SliceOverlapPos   
)
SIM_IndexField::GETSET_DATA_FUNCS_V3 ( "totalvoxelres"  ,
TotalVoxelRes   
)
UT_Vector3 SIM_IndexField::getSize ( ) const
exint SIM_IndexField::getValue ( const UT_Vector3 pos) const

Access the field value given a world space location. This does closest point matching.

fpreal SIM_IndexField::getVoxelDiameter ( ) const
SIM_FieldSample SIM_IndexField::getVoxelSample ( ) const
const UT_Vector3& SIM_IndexField::getVoxelSize ( ) const
bool SIM_IndexField::indexToPos ( int  x,
int  y,
int  z,
UT_Vector3 pos 
) const

Converts an integer index into a worldspace position.

bool SIM_IndexField::indexToPos ( exint  x,
exint  y,
exint  z,
UT_Vector3D pos 
) const
virtual void SIM_IndexField::initializeSubclass ( )
protectedvirtual

Overrides to properly implement this class as a SIM_Data.

Reimplemented from SIM_Data.

virtual bool SIM_IndexField::loadSubclass ( UT_IStream is)
protectedvirtual

Loads our attributes and internal data if it was set when we saved.

Reimplemented from SIM_Data.

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

myField aware copy constructor.

Reimplemented from SIM_Data.

void SIM_IndexField::matchField ( const SIM_ScalarField field)

Match this field to the given reference field. We will end up with the same size/divisions/twod/uniform, but not the same sampling pattern

void SIM_IndexField::matchField ( const SIM_VectorField field)
void SIM_IndexField::matchField ( const SIM_MatrixField field)
void SIM_IndexField::matchField ( const SIM_IndexField field,
bool  matchsamples = false 
)
virtual void SIM_IndexField::optionChangedSubclass ( const char *  name)
protectedvirtual

Override the setDivisions to rebuild our voxel array on demand.

Reimplemented from SIM_OptionsUser.

bool SIM_IndexField::posToIndex ( const UT_Vector3 pos,
int x,
int y,
int z 
) const

Converts a worldspace position into an integer index.

void SIM_IndexField::pubHandleModification ( )
inline

Signals to the field that it has been altered externally.

Definition at line 140 of file SIM_IndexField.h.

void SIM_IndexField::resizeKeepData ( const UT_Vector3 size,
const UT_Vector3 center,
bool  keepdata,
const char *  address = 0,
int  port = -1 
)

Resizes our field keeping our field data. The final size will be an integer number of voxels matching our current voxel size. The final center will be an integer number of voxel offset from our current center. This allows us to do a perfect copy of the data.

virtual void SIM_IndexField::saveSubclass ( std::ostream &  os) const
protectedvirtual

Saves our attributes, and our internal data if it has been set.

Reimplemented from SIM_Data.

void SIM_IndexField::setBorder ( UT_VoxelBorderType  border)
inline

Definition at line 64 of file SIM_IndexField.h.

void SIM_IndexField::setCenter ( const UT_Vector3 div)
void SIM_IndexField::setDivisions ( const UT_Vector3 div)

Adjusts the size/divisions of this field, overriding and twod or uniform voxel settings.

void SIM_IndexField::setField ( SIM_RawIndexField field)

Sets the field to the given field, gaining ownership of it.

void SIM_IndexField::setSize ( const UT_Vector3 div)
void SIM_IndexField::setVoxelSize ( const UT_Vector3 voxelsize)
inline

Definition at line 106 of file SIM_IndexField.h.

SIM_RawIndexField* SIM_IndexField::stealField ( )

Steals the field, replacing this copy with an empty field and returning the old version.

bool SIM_IndexField::testForNan ( ) const
inline

Can't have NANs in integer fields.

Definition at line 127 of file SIM_IndexField.h.

void SIM_IndexField::updateTotalVoxels ( )

Recomputes total number of voxels to be stored on our options data for ease of reading


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