SIM_SDF Class Reference

This class holds a signed distance function representing a GU_Detail. More...

#include <SIM_SDF.h>

Inheritance diagram for SIM_SDF:

List of all members.

Public Member Functions
	GETSET_DATA_FUNCS_I (SIM_NAME_MODE, Mode)
	Control the number of divisions.
	GETSET_DATA_FUNCS_V3 (SIM_NAME_DIV, Divisions)
	GETSET_DATA_FUNCS_B (SIM_NAME_LASERSCAN, LaserScan)
	GETSET_DATA_FUNCS_B (SIM_NAME_FIXSIGNS, FixSigns)
	GETSET_DATA_FUNCS_B (SIM_NAME_FORCEBOUNDS, ForceBounds)
	GETSET_DATA_FUNCS_F (SIM_NAME_OFFSET, Offset)
	GETSET_DATA_FUNCS_F (SIM_NAME_TOLERANCE, Tolerance)
	GETSET_DATA_FUNCS_B (SIM_NAME_INVERT, Invert)
	GETSET_DATA_FUNCS_I ("sweepcount", SweepCount)
	GETSET_DATA_FUNCS_F ("sweepalpha", SweepThreshold)
const GU_SDF &	getSDF () const
	Get the SDF.
GU_ConstDetailHandle	createSmokeRepresentation (const SIM_RootData &root) const
void	addSmokeRepresentation (const SIM_RootData &root, GU_Detail *gdp) const
void	setSDF (GU_SDF *sdf)
	Forcibly changes the SDF to the given mapping.
GU_SDF *	stealSDF ()
UT_VoxelMipMapF *	getMipMap () const
	Returns voxel mipmap for this sdf.
Protected Member Functions
	SIM_SDF (const SIM_DataFactory *factory)
virtual	~SIM_SDF ()
virtual void	initializeSubclass ()
	Overrides to properly implement this class as a SIM_Data.
virtual void	saveSubclass (ostream &os) const
	Saves our attributes, and our internal data if it has been set.
virtual bool	loadSubclass (UT_IStream &is)
	Loads our attributes and internal data if it was set when we saved.
virtual int64	getMemorySizeSubclass () const
virtual bool	getIsAlternateRepresentationSubclass () const
virtual void	initAlternateRepresentationSubclass (const SIM_Data &)
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

---

Detailed Description

This class holds a signed distance function representing a GU_Detail.

Definition at line 35 of file SIM_SDF.h.

---

Constructor & Destructor Documentation

SIM_SDF::SIM_SDF

(

const SIM_DataFactory *

factory

)

[explicit, protected]

virtual SIM_SDF::~SIM_SDF

(

)

[protected, virtual]

---

Member Function Documentation

void SIM_SDF::addSmokeRepresentation	(	const SIM_RootData &	root,
		GU_Detail *	gdp
	)			const

virtual void SIM_SDF::buildGuideGeometrySubclass	(	const SIM_RootData &	root,
		const SIM_Options &	options,
		const GU_DetailHandle &	gdh,
		UT_DMatrix4 *	xform,
		const SIM_Time &	t
	)			const [protected, virtual]

Override this function to create custom guide geometry for this class. This method should add geometry to the gdp (if supplied), not alter anything that is already there. The xform will always default to an identity matrix. The gdp pointer or the xform pointer may be null, in which case the other should still be calculated.

Reimplemented from SIM_Data.

virtual SIM_Guide* SIM_SDF::createGuideObjectSubclass

(

)

const [protected, virtual]

Override this to create a custom SIM_Guide subclass. The SIM_Guide class controls how requests for guide geometry are translated into actual geometry creation.

Reimplemented from SIM_Data.

GU_ConstDetailHandle SIM_SDF::createSmokeRepresentation

(

const SIM_RootData &

root

)

const

Create a GU_Detail with the SDF present as a volume primitive

virtual bool SIM_SDF::getIsAlternateRepresentationSubclass

(

)

const [protected, virtual]

Override this method to return true if your data type is built on demand. This is true for data that is just an alternative representation of some other data. This has several consequences. First, it implies that the data can be rebuilt from other data on the object, therefore it is not saved to disk. Also, it is assumed to be represent its parent data, so any modifications to the parent data cause this data to be deleted. If you override this method, do not call the base class implementation.

Reimplemented from SIM_Data.

virtual int64 SIM_SDF::getMemorySizeSubclass

(

)

const [protected, virtual]

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.

UT_VoxelMipMapF* SIM_SDF::getMipMap

(

)

const

Returns voxel mipmap for this sdf.

const GU_SDF& SIM_SDF::getSDF

(

)

const

Get the SDF.

SIM_SDF::GETSET_DATA_FUNCS_B	(	SIM_NAME_INVERT	,
		Invert
	)

SIM_SDF::GETSET_DATA_FUNCS_B	(	SIM_NAME_FORCEBOUNDS	,
		ForceBounds
	)

SIM_SDF::GETSET_DATA_FUNCS_B	(	SIM_NAME_FIXSIGNS	,
		FixSigns
	)

SIM_SDF::GETSET_DATA_FUNCS_B	(	SIM_NAME_LASERSCAN	,
		LaserScan
	)

SIM_SDF::GETSET_DATA_FUNCS_F	(	"sweepalpha"	,
		SweepThreshold
	)

SIM_SDF::GETSET_DATA_FUNCS_F	(	SIM_NAME_TOLERANCE	,
		Tolerance
	)

SIM_SDF::GETSET_DATA_FUNCS_F	(	SIM_NAME_OFFSET	,
		Offset
	)

SIM_SDF::GETSET_DATA_FUNCS_I	(	"sweepcount"	,
		SweepCount
	)

SIM_SDF::GETSET_DATA_FUNCS_I	(	SIM_NAME_MODE	,
		Mode
	)

Control the number of divisions.

SIM_SDF::GETSET_DATA_FUNCS_V3	(	SIM_NAME_DIV	,
		Divisions
	)

virtual void SIM_SDF::initAlternateRepresentationSubclass

(

const SIM_Data &

)

[protected, virtual]

Override this function if getIsAlternateRepresentationSubclass() is overridden to return true. This function is used to initialize the alternate representation based on the data to which it was just attached.

Reimplemented from SIM_Data.

virtual void SIM_SDF::initializeSubclass

(

)

[protected, virtual]

Overrides to properly implement this class as a SIM_Data.

Reimplemented from SIM_Data.

virtual bool SIM_SDF::loadSubclass

(

UT_IStream &

is

)

[protected, virtual]

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

Reimplemented from SIM_Data.

virtual void SIM_SDF::saveSubclass

(

ostream &

os

)

const [protected, virtual]

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

Reimplemented from SIM_Data.

void SIM_SDF::setSDF

(

GU_SDF *

sdf

)

Forcibly changes the SDF to the given mapping.

GU_SDF* SIM_SDF::stealSDF

(

)

Steals the current SDF, replacing it with a blank one. This is used to allow the IsoOffset SOP to extract an SDF loaded into a simulation without having to copy it.

---

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

• SIM/SIM_SDF.h