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

#include <SIM_SopScalarField.h>

+ Inheritance diagram for SIM_SopScalarField:

Public Member Functions

 GETSET_DATA_FUNCS_B ("usesopdimensions", UseSopDimensions)
 GETSET_DATA_FUNCS_B ("sopresizeonly", SopResizeOnly)
 GETSET_DATA_FUNCS_F ("scalevalue", ScaleValue)
 GETSET_DATA_FUNCS_I ("primnum", PrimNumber)
- Public Member Functions inherited from SIM_ScalarField
 Control the number of divisions. More...
 GETSET_DATA_FUNCS_I ("uniformdiv", RawUniformDivisions)
 GETSET_DATA_FUNCS_F ("divsize", RawDivisionSize)
 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_F ("initialvalue", InitialValue)
 GETSET_DATA_FUNCS_B ("usefp16", UseFP16)
 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 &size)
void setCenter (const UT_Vector3 &center)
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, bool matchsample=false)
void matchField (const SIM_VectorField *field)
void matchField (const SIM_MatrixField *field)
void matchField (const SIM_IndexField *field)
void matchVolume (const GEO_PrimVolume *vol, const UT_DMatrix4 &xform)
void matchVDB (const GEO_PrimVDB *vdb, const UT_DMatrix4 &xform)
SIM_FieldSample getVoxelSample () const
void setVoxelSample (SIM_FieldSample sample)
const UT_Vector3getVoxelSize () const
fpreal getVoxelDiameter () const
fpreal getValue (const UT_Vector3 &pos) const
UT_Vector3 getGradient (const UT_Vector3 &pos) const
 Determines the gradient at the given location. More...
void advect (const SIM_VectorField *vel, float timestep, const SIM_RawField *collision, SIM_FieldAdvection advectmethod, float cfl)
 Advects this field by the other given field. More...
void advect (sim_PointVelocity getVelocity, float timestep, float voxelsize, const SIM_RawField *collision=0, float cfl=1.0f)
void advectMinMax (SIM_ScalarField *minfield, SIM_ScalarField *maxfield, const SIM_VectorField *vel, float timestep, const SIM_RawField *collision, SIM_FieldAdvection advectmethod, float cfl)
void enforceBoundary (const SIM_ScalarField *collision=0, const SIM_ScalarField *colvalue=0, const SIM_ScalarField *boundvalue=0)
 Enforces the boundary condition with the given collision mask. More...
bool indexToPos (int x, int y, int z, UT_Vector3 &pos) const
 Converts an integer index into a worldspace position. More...
bool posToIndex (const UT_Vector3 &pos, int &x, int &y, int &z) const
 Converts a worldspace position into an integer index. More...
SIM_RawFieldgetField () const
 Retrieve raw field. More...
void setField (SIM_RawField *field)
 Sets the field to the given field, gaining ownership of it. More...
bool hasNan () const
 True if we contain any NANs. More...
bool appearsToBeUnused () const
SIM_RawFieldstealField ()
void testForNan () const
void pubHandleModification ()
 Signals to the field that it has been altered externally. More...
void markGridAsChanged ()
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_SopScalarField (const SIM_DataFactory *factory)
virtual ~SIM_SopScalarField ()
virtual void handleModificationSubclass (int code)
virtual void interpolateSubclass (const SIM_Data *source1, const SIM_Data *source2, fpreal interp)
- Protected Member Functions inherited from SIM_ScalarField
 SIM_ScalarField (const SIM_DataFactory *factory)
virtual ~SIM_ScalarField ()
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 int64 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 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

- Public Types inherited from SIM_ScalarField
typedef SIM_RawField rawfield_type
- 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

Definition at line 21 of file SIM_SopScalarField.h.

Constructor & Destructor Documentation

SIM_SopScalarField::SIM_SopScalarField ( const SIM_DataFactory factory)
virtual SIM_SopScalarField::~SIM_SopScalarField ( )

Member Function Documentation

SIM_SopScalarField::GETSET_DATA_FUNCS_B ( "usesopdimensions"  ,
SIM_SopScalarField::GETSET_DATA_FUNCS_B ( "sopresizeonly"  ,
SIM_SopScalarField::GETSET_DATA_FUNCS_F ( "scalevalue"  ,
SIM_SopScalarField::GETSET_DATA_FUNCS_I ( "primnum"  ,
virtual void SIM_SopScalarField::handleModificationSubclass ( int  code)

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.

virtual void SIM_SopScalarField::interpolateSubclass ( const SIM_Data source1,
const SIM_Data source2,
fpreal  interp 

Override this method to customize the interpolation behavior. The interp parameter will always be greater than 0 and less than one in this call. Values outside this range are handled by the interpolate() function by calling makeEqual() on one source or the other. The default implementation calls makeEqualSubclass() on source1 or source2 depending on whether interp is less or greater than 0.5. Both source1 and source2 are guaranteed to be non-null in this call. Subclasses should not call the base class implementation, except in the case of an error condition which prevents the custom interpolation from functioning properly. You should also not call makeEqual() from this function, though makeEqualSubclass() is acceptable.

Reimplemented from SIM_Data.

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