SIM_ScalarFieldVisualization Class Reference

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

#include <SIM_ScalarFieldVisualization.h>

Inheritance diagram for SIM_ScalarFieldVisualization:

List of all members.

Public Member Functions
	GET_GUIDE_FUNC_B (SIM_NAME_SHOWGUIDE, ShowGuide, true)
	GET_GUIDE_FUNC_V3 (SIM_NAME_COLOR, Color,(1, 1, 1))
	GET_GUIDE_FUNC_F ("guideiso", GuideIso, 0.0)
	GET_GUIDE_FUNC_B ("guideinvert", GuideInvert, false)
	GET_GUIDE_FUNC_B ("usesmoke", UseSmoke, false)
	GET_GUIDE_FUNC_B ("guideremapsmoke", GuideRemapSmoke, false)
	GET_GUIDE_FUNC_F ("guidesmokedensity", GuideSmokeDensity, 10.0)
	GET_GUIDE_FUNC_B ("usebox", UseBox, false)
	GET_GUIDE_FUNC_B ("useboxhash", UseBoxHash, false)
	GET_GUIDE_FUNC_B ("guideuseplane", GuideUsePlane, false)
	GET_GUIDE_FUNC_I ("guideplane", GuidePlane, 0)
	GET_GUIDE_FUNC_I ("guidevismode", GuideVisMode, 0)
	GET_GUIDE_FUNC_I ("guidevisdensitymode", GuideVisDensityMode, 0)
	GET_GUIDE_FUNC_V2 ("guiderange", GuideRange,(0, 1))
	GET_GUIDE_FUNC_F ("guideplaneval", GuidePlaneVal, 0)
	GET_GUIDE_FUNC_B ("guiderangemode", GuideRangeMode, false)
	GET_GUIDE_FUNC_F ("guiderangecenter", GuideRangeCenter, 0.5)
	GET_GUIDE_FUNC_F ("guiderangesize", GuideRangeSize, 1)
Static Public Member Functions
static void	createBoundingBoxGuide (GU_Detail *gdp, const UT_BoundingBox &bbox, int xdiv, int ydiv, int zdiv, const UT_Vector3 &color, const GB_AttributeRef &primclroff, const GB_AttributeRef &ptclroff)
Protected Member Functions
	SIM_ScalarFieldVisualization (const SIM_DataFactory *factory)
virtual	~SIM_ScalarFieldVisualization ()
virtual void	initializeSubclass ()
	Overrides to properly implement this class as a SIM_Data.
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 40 of file SIM_ScalarFieldVisualization.h.

---

Constructor & Destructor Documentation

SIM_ScalarFieldVisualization::SIM_ScalarFieldVisualization

(

const SIM_DataFactory *

factory

)

[explicit, protected]

virtual SIM_ScalarFieldVisualization::~SIM_ScalarFieldVisualization

(

)

[protected, virtual]

---

Member Function Documentation

virtual void SIM_ScalarFieldVisualization::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.

static void SIM_ScalarFieldVisualization::createBoundingBoxGuide	(	GU_Detail *	gdp,
		const UT_BoundingBox &	bbox,
		int	xdiv,
		int	ydiv,
		int	zdiv,
		const UT_Vector3 &	color,
		const GB_AttributeRef &	primclroff,
		const GB_AttributeRef &	ptclroff
	)			[static]

Adds a wire frame bounding box of the specified dimensions and with colour set to the given offset. If xdiv..zdiv are non-zero, the box will be hatched accordingly.

virtual SIM_Guide* SIM_ScalarFieldVisualization::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.

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_B	(	"guiderangemode"	,
		GuideRangeMode	,
		false
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_B	(	"guideuseplane"	,
		GuideUsePlane	,
		false
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_B	(	"useboxhash"	,
		UseBoxHash	,
		false
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_B	(	"usebox"	,
		UseBox	,
		false
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_B	(	"guideremapsmoke"	,
		GuideRemapSmoke	,
		false
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_B	(	"usesmoke"	,
		UseSmoke	,
		false
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_B	(	"guideinvert"	,
		GuideInvert	,
		false
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_B	(	SIM_NAME_SHOWGUIDE	,
		ShowGuide	,
		true
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_F	(	"guiderangesize"	,
		GuideRangeSize	,
		1
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_F	(	"guiderangecenter"	,
		GuideRangeCenter	,
		0.	5
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_F	(	"guideplaneval"	,
		GuidePlaneVal	,
		0
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_F	(	"guidesmokedensity"	,
		GuideSmokeDensity	,
		10.	0
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_F	(	"guideiso"	,
		GuideIso	,
		0.	0
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_I	(	"guidevisdensitymode"	,
		GuideVisDensityMode	,
		0
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_I	(	"guidevismode"	,
		GuideVisMode	,
		0
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_I	(	"guideplane"	,
		GuidePlane	,
		0
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_V2	(	"guiderange"	,
		GuideRange	,
		(0, 1)
	)

SIM_ScalarFieldVisualization::GET_GUIDE_FUNC_V3	(	SIM_NAME_COLOR	,
		Color	,
		(1, 1, 1)
	)

virtual bool SIM_ScalarFieldVisualization::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 void SIM_ScalarFieldVisualization::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_ScalarFieldVisualization::initializeSubclass

(

)

[protected, virtual]

Overrides to properly implement this class as a SIM_Data.

Reimplemented from SIM_Data.

---

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

• SIM/SIM_ScalarFieldVisualization.h