SIM_VectorFieldVisualization Class Reference

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

#include <SIM_VectorFieldVisualization.h>

Inheritance diagram for SIM_VectorFieldVisualization:

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_B ("guideusesmoke", GuideUseSmoke, false)
	GET_GUIDE_FUNC_B ("guideusebox", GuideUseBox, false)
	GET_GUIDE_FUNC_B ("guideuseboxhash", GuideUseBoxHash, false)
	GET_GUIDE_FUNC_F ("guidescale", GuideScale, 1.0)
	GET_GUIDE_FUNC_I ("guidevistype", GuideVisType, 0)
	GET_GUIDE_FUNC_I ("guidevismode", GuideVisMode, 0)
	GET_GUIDE_FUNC_F ("guidevisscale", GuideVisScale, 1.0)
	GET_GUIDE_FUNC_B ("guideoverridediv", GuideOverrideDiv, false)
	GET_GUIDE_FUNC_V3 ("guidediv", GuideDiv,(10, 10, 10))
	GET_GUIDE_FUNC_B ("guideusestreamers", GuideUseStreamers, false)
	GET_GUIDE_FUNC_I ("guideplane", GuidePlane, 0)
	GET_GUIDE_FUNC_V3 ("guideplanepos", GuidePlanePos,(0, 0, 0))
	GET_GUIDE_FUNC_F ("guidestreamerlen", GuideStreamerLen, 1)
	GET_GUIDE_FUNC_F ("guidestreamerminspeed", GuideStreamerMinSpeed, 0)
	GET_GUIDE_FUNC_B ("guidebarbs", GuideBarbs, true)
	GET_GUIDE_FUNC_B ("guidepercomp", GuidePerComp, false)
Static Public Member Functions
static void	createVectorGuide (GU_Detail *gdp, const UT_Vector3 &pos, const UT_Vector3 &vel, int clroff, const UT_Vector3 &clr, bool usebarbs)
Protected Member Functions
	SIM_VectorFieldVisualization (const SIM_DataFactory *factory)
virtual	~SIM_VectorFieldVisualization ()
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 37 of file SIM_VectorFieldVisualization.h.

---

Constructor & Destructor Documentation

SIM_VectorFieldVisualization::SIM_VectorFieldVisualization

(

const SIM_DataFactory *

factory

)

[explicit, protected]

virtual SIM_VectorFieldVisualization::~SIM_VectorFieldVisualization

(

)

[protected, virtual]

---

Member Function Documentation

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

static void SIM_VectorFieldVisualization::createVectorGuide	(	GU_Detail *	gdp,
		const UT_Vector3 &	pos,
		const UT_Vector3 &	vel,
		int	clroff,
		const UT_Vector3 &	clr,
		bool	usebarbs
	)			[static]

Adds to the gdp a simple vector starting at pos and in direction vel.

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_B	(	"guidepercomp"	,
		GuidePerComp	,
		false
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_B	(	"guidebarbs"	,
		GuideBarbs	,
		true
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_B	(	"guideusestreamers"	,
		GuideUseStreamers	,
		false
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_B	(	"guideoverridediv"	,
		GuideOverrideDiv	,
		false
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_B	(	"guideuseboxhash"	,
		GuideUseBoxHash	,
		false
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_B	(	"guideusebox"	,
		GuideUseBox	,
		false
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_B	(	"guideusesmoke"	,
		GuideUseSmoke	,
		false
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_B	(	SIM_NAME_SHOWGUIDE	,
		ShowGuide	,
		true
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_F	(	"guidestreamerminspeed"	,
		GuideStreamerMinSpeed	,
		0
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_F	(	"guidestreamerlen"	,
		GuideStreamerLen	,
		1
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_F	(	"guidevisscale"	,
		GuideVisScale	,
		1.	0
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_F	(	"guidescale"	,
		GuideScale	,
		1.	0
	)

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

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

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_I	(	"guidevistype"	,
		GuideVisType	,
		0
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_V3	(	"guideplanepos"	,
		GuidePlanePos	,
		(0, 0, 0)
	)

SIM_VectorFieldVisualization::GET_GUIDE_FUNC_V3	(	"guidediv"	,
		GuideDiv	,
		(10, 10, 10)
	)

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

virtual bool SIM_VectorFieldVisualization::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_VectorFieldVisualization::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_VectorFieldVisualization::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_VectorFieldVisualization.h