#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 (SIM_NAME_TIME, Time)

	GETSET_DATA_FUNCS_F ("scalevalue", ScaleValue)

	GETSET_DATA_FUNCS_S (SIM_NAME_SOPPATH, SopPath)

	GETSET_DATA_FUNCS_I ("primnum", PrimNumber)

	GETSET_DATA_FUNCS_B (SIM_NAME_USETRANSFORM, UseTransform)

	GETSET_DATA_FUNCS_B (SIM_NAME_LETSOPSINTERPOLATE, LetSopsInterpolate)

Public Member Functions inherited from SIM_ScalarField
	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_F ("initialvalue", InitialValue)

	GETSET_DATA_FUNCS_F (SIM_NAME_TOLERANCE, Tolerance)

	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_Vector3 &	getVoxelSize () const

void	setVoxelSize (const UT_Vector3 &voxelsize)

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

const SIM_RawField *	getField () const
	Retrieve raw field. More...

SIM_RawField *	getField ()

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_RawField *	stealField ()

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_Data &root) const
	Creates a GDP with us as a Volume Primitive inside it. More...

void	addSmokeRepresentation (const SIM_Data &root, GU_Detail *gdp) const

Public Member Functions inherited from SIM_Data
const UT_StringHolder &	getDataType () 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 void *	getConstPointerToType (const UT_StringRef &datatype) const

void *	getPointerToType (const UT_StringRef &datatype)

int	getNumSubData () const
	Get the number of sub-data items attached to this data. More...

const UT_StringHolder &	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_Query &	getQueryObject () const

SIM_Options *	getUserOptions ()

const SIM_Options *	getConstUserOptions () 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_Data *	getSubData (int index)

const SIM_Data *	getConstSubData (int index) const

SIM_Data *	getNamedSubData (const char *dataname)

const SIM_Data *	getConstNamedSubData (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_Data *	getNthSubData (UT_String name, const SIM_DataFilter &filter, int n, const char startfrom, const SIM_DataFilter &recurseFilter)

const SIM_Data *	getNthConstSubData (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_Data *	createNamedSubData (const char dataname, const char datatype, int creationflags, UT_String *newdatanameptr=NULL)

SIM_Data *	getOrCreateAlternateRepresentation (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_Guid &	getUniqueId () const

long	getReferenceCount () const

int	getCreatorId () const
	Get the ID of the node that created this data. More...

OP_Node *	getCreatorNode () const
	Use the creator ID to look up the OP_Node that created this data. More...

OP_Node *	getOwnerNetwork () const
	Look up the owner node of our engine to get the DOP Network pointer. More...

const SIM_Engine &	getEngine () 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_Time &	getCreationTime () 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_Node &	getNodePathsRelativeTo () const

OP_Node *	getOPNode (const char *path, bool addinterest) const
	Given a path relative to our creator node, return an OBJ_Node. More...

OBJ_Node *	getOBJNode (const char *path, bool addinterest) const
	Given a path relative to our creator node, return an OBJ_Node. More...

SOP_Node *	getSOPNode (const char *path, bool addinterest) const
	Given a path relative to our creator node, return a SOP_Node. More...

DOP_Node *	getDOPNode (const char *path, bool addinterest) const
	Given a path relative to our creator node, return a DOP_Node. More...

COP2_Node *	getCOP2Node (const char *path, bool addinterest) const
	Given a path relative to our creator node, return a COP2_Node. More...

CHOP_Node *	getCHOPNode (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_Options &	getOptions () const

Protected Member Functions
	SIM_SopScalarField (const SIM_DataFactory *factory)

	~SIM_SopScalarField () override

void	handleModificationSubclass (int code) override

void	interpolateSubclass (const SIM_Data source1, const SIM_Data source2, fpreal interp) override

Protected Member Functions inherited from SIM_ScalarField
	SIM_ScalarField (const SIM_DataFactory *factory)

	~SIM_ScalarField () override

void	initializeSubclass () override
	Overrides to properly implement this class as a SIM_Data. More...

void	makeEqualSubclass (const SIM_Data *source) override
	myField aware copy constructor. More...

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

int64	getMemorySizeSubclass () const override

void	optionChangedSubclass (const char *name) override
	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_Query *	createQueryObjectSubclass () const

virtual long	getGuideParmVersionSubclass () const

virtual SIM_Guide *	createGuideObjectSubclass () 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 void *	getCastToType (const UT_StringRef &datatype) const

virtual const UT_StringHolder &	getDataTypeSubclass () const

const SIM_Data *	getAlternateRepresentationOf () const

Protected Member Functions inherited from SIM_OptionsUser
SIM_Options &	getOptions ()

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 void *	castConstPointerToType (const SIM_Data *data, const UT_StringRef &datatype)

static void *	castPointerToType (SIM_Data *data, const UT_StringRef &datatype)

Static Protected Member Functions inherited from SIM_Data
static const PRM_Template *	getEmptyTemplateList ()

static const SIM_DopDescription *	getEmptyDopDescription ()
	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 )

explicitprotected

SIM_SopScalarField::~SIM_SopScalarField ( )

overrideprotected

Member Function Documentation

SIM_SopScalarField::GETSET_DATA_FUNCS_B	(	"usesopdimensions"	,
		UseSopDimensions
	)

SIM_SopScalarField::GETSET_DATA_FUNCS_B	(	"sopresizeonly"	,
		SopResizeOnly
	)

SIM_SopScalarField::GETSET_DATA_FUNCS_B	(	SIM_NAME_USETRANSFORM	,
		UseTransform
	)

SIM_SopScalarField::GETSET_DATA_FUNCS_B	(	SIM_NAME_LETSOPSINTERPOLATE	,
		LetSopsInterpolate
	)

SIM_SopScalarField::GETSET_DATA_FUNCS_F	(	SIM_NAME_TIME	,
		Time
	)

SIM_SopScalarField::GETSET_DATA_FUNCS_F	(	"scalevalue"	,
		ScaleValue
	)

SIM_SopScalarField::GETSET_DATA_FUNCS_I	(	"primnum"	,
		PrimNumber
	)

SIM_SopScalarField::GETSET_DATA_FUNCS_S	(	SIM_NAME_SOPPATH	,
		SopPath
	)

void SIM_SopScalarField::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.

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

overrideprotectedvirtual

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:

SIMZ/SIM_SopScalarField.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation