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

#include <SIM_VectorFieldVisualization.h>

Inheritance diagram for SIM_VectorFieldVisualization:

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_V2 ("guiderange", GuideRange,(0, 1))

	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_B ("guideuseplane", GuideUsePlane, false)

	GET_GUIDE_FUNC_I ("guideplane", GuidePlane, 0)

	GET_GUIDE_FUNC_F ("guideplaneval", GuidePlaneVal, 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)

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

Static Public Member Functions
static void	createVectorGuide (GU_Detail *gdp, const UT_Vector3 &pos, const UT_Vector3 &vel, const GA_RWHandleV3 &clrh, const UT_Vector3 &clr, bool usebarbs)

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)

Protected Member Functions
	SIM_VectorFieldVisualization (const SIM_DataFactory *factory)

	~SIM_VectorFieldVisualization () override

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

bool	getIsAlternateRepresentationSubclass () const override

void	initAlternateRepresentationSubclass (const SIM_Data &) override

SIM_Guide *	createGuideObjectSubclass () const override

void	buildGuideGeometrySubclass (const SIM_RootData &root, const SIM_Options &options, const GU_DetailHandle &gdh, UT_DMatrix4 *xform, const SIM_Time &t) const override

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	makeEqualSubclass (const SIM_Data *source)

virtual void	saveSubclass (std::ostream &os) const

virtual void	saveIOSubclass (std::ostream &os, SIM_DataThreadedIO *io) const

virtual bool	loadSubclass (UT_IStream &is)

virtual bool	loadIOSubclass (UT_IStream &is, SIM_DataThreadedIO *io)

virtual SIM_Query *	createQueryObjectSubclass () const

virtual long	getGuideParmVersionSubclass () 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 void	interpolateSubclass (const SIM_Data source1, const SIM_Data source2, fpreal interp)

virtual int64	getMemorySizeSubclass () const

virtual void	handleModificationSubclass (int code)

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 ()

virtual void	optionChangedSubclass (const char *name)

Additional Inherited Members
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

This class holds a signed distance function representing a GU_Detail.

Definition at line 29 of file SIM_VectorFieldVisualization.h.

Constructor & Destructor Documentation

SIM_VectorFieldVisualization::SIM_VectorFieldVisualization ( const SIM_DataFactory * factory )

explicitprotected

SIM_VectorFieldVisualization::~SIM_VectorFieldVisualization ( )

overrideprotected

Member Function Documentation

void SIM_VectorFieldVisualization::buildGuideGeometrySubclass	(	const SIM_RootData &	root,
		const SIM_Options &	options,
		const GU_DetailHandle &	gdh,
		UT_DMatrix4 *	xform,
		const SIM_Time &	t
	)		const

overrideprotectedvirtual

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.

SIM_Guide* SIM_VectorFieldVisualization::createGuideObjectSubclass ( ) const

overrideprotectedvirtual

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,
		const GA_RWHandleV3 &	clrh,
		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	(	SIM_NAME_SHOWGUIDE	,
		ShowGuide	,
		true
	)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool SIM_VectorFieldVisualization::getIsAlternateRepresentationSubclass ( ) const

overrideprotectedvirtual

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.

void SIM_VectorFieldVisualization::initAlternateRepresentationSubclass ( const SIM_Data & )

overrideprotectedvirtual

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.

void SIM_VectorFieldVisualization::initializeSubclass ( )

overrideprotectedvirtual

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation