VectorGlypher Class Reference

Glypher that produces vectors at each node of a model, scaled and oriented based on a specific state of that particular node / element. If no node state is available, a default value will be used. More...

#include <Rendering/SceneComponents/Models/vectorglypher.h>

Inheritance diagram for VectorGlypher:

Public Member Functions
	VectorGlypher ()
	VectorGlypher (const VectorGlypher &glypher)
	~VectorGlypher () override
VectorGlypher *	clone () const override
bool	getDrawArrowHeads () const
Glyph	getGlyph (const Mesh::NodeHandle &node) override
double	getLengthScale () const
Mesh::MeshModelLibrary &	getMeshModelLibrary () override
bool	getUseScaleAsLength () const
const Mesh::VectorNodeMapper &	getVectorNodeMapper () const
bool	load (const DataExecution::SerializedItem &item) override
VectorGlypher &	operator= (const VectorGlypher &glypher)
bool	save (DataExecution::SerializedItem &item) const override
void	setDrawArrowHeads (bool b)
void	setGlyphedModel (const Mesh::MeshModelInterface &model) override
void	setLengthScale (double scale)
void	setUseScaleAsLength (bool b)
void	setVectorNodeMapper (Mesh::VectorNodeMapper &mapper)
Public Member Functions inherited from Glypher
	~Glypher () override
bool	canSerialize () const override
Glypher *	clone () const override=0
QString	getCacheId () const
bool	getEnabled () const
virtual Glyph	getGlyph (const Mesh::ElementHandle &element)
virtual Glyph	getGlyph (const Mesh::NodeHandle &node)=0
int	getInterval () const
virtual Mesh::MeshModelLibrary &	getMeshModelLibrary ()=0
virtual bool	isElementGlypher (const CSIRO::Mesh::ElementType::Type **elementType) const
virtual bool	isNodeGlypher () const
bool	load (const DataExecution::SerializedItem &item) override
bool	save (DataExecution::SerializedItem &item) const override
void	setEnabled (bool b)
virtual void	setGlyphedModel (const Mesh::MeshModelInterface &model)
void	setInterval (int interval)
void	setIntervalStateName (const QString &stateName)
Public Member Functions inherited from Clonable
virtual	~Clonable ()=default
virtual Clonable *	clone () const =0
Public Member Functions inherited from Serialize
virtual	~Serialize ()=default
virtual bool	canSerialize () const =0
virtual bool	load (const SerializedItem &item)=0
virtual bool	save (SerializedItem &item) const =0

Additional Inherited Members
Protected Member Functions inherited from Glypher
	Glypher ()
	Glypher (const Glypher &glypher)
bool	matchInterval (const Mesh::ElementHandle &elt) const
bool	matchInterval (const Mesh::NodeHandle &node) const
Glypher &	operator= (const Glypher &glypher)

Detailed Description

Constructor & Destructor Documentation

VectorGlypher() [1/2]

VectorGlypher

(

)

VectorGlypher() [2/2]

VectorGlypher

(

const VectorGlypher &

glypher

)

~VectorGlypher()

~VectorGlypher ( )

override

Member Function Documentation

clone()

VectorGlypher * clone ( ) const

overridevirtual

Returns

A clone of this object.

Note

Subclasses would normally return their own type rather than the Clonable type. The C++ language rules allow a more derived type to be returned from a virtual function and the compiler will still treat it as a valid override.

Implements Glypher.

getDrawArrowHeads()

bool getDrawArrowHeads

(

)

const

getGlyph()

Glyph getGlyph ( const Mesh::NodeHandle &  node )

overridevirtual

Parameters

node	The node for which a glyph should be returned.

Returns

A glyph object which can be used for the specified node. It is allowable for this function to return an invalid glyph to indicate that no glyph should be used for this node.

Implements Glypher.

getLengthScale()

double getLengthScale

(

)

const

getMeshModelLibrary()

Mesh::MeshModelLibrary & getMeshModelLibrary ( )

overridevirtual

Returns

The mesh model library the glypher uses to hold its glyphs. Most glyphers will employ their own internal model library (possibly shared between all glyphers of that type) for efficiency reasons and to keep model id's short and simple.

Implements Glypher.

getUseScaleAsLength()

bool getUseScaleAsLength

(

)

const

getVectorNodeMapper()

const Mesh::VectorNodeMapper & getVectorNodeMapper

(

)

const

load()

bool load ( const DataExecution::SerializedItem &  item )

overridevirtual

Parameters

item	Supplies the state to be loaded into this object.

This function will load the state of this object from item. For many object types, this is most easily implemented in terms of the object's input operator (>>).

It would be reasonable for subclass implementations to assume that the data provided in item is in the same form as would have been saved from a call to save.

Returns

If the state of the object could not be loaded, the function returns false. A return value of true implies that the object state was successfully loaded. If canSerialize() returns false, this function must do nothing except return false as well.

Reimplemented from Glypher.

operator=()

VectorGlypher & operator=

(

const VectorGlypher &

glypher

)

save()

bool save ( DataExecution::SerializedItem &  item ) const

overridevirtual

Parameters

item	Where to save the state of this object.

This function will serialise the object by saving it to item. For most object types, this is most easily implemented in terms of the object's output operator (<<).

It is allowable for an object to only serialize part of itself. This would be useful if the data it represents has a set of defaults and only those values different to the defaults need to be serialized. Such an implementation then needs to be careful how it handles the complimentary load member function.

Returns

If an object could not be serialised or if the underlying object type does not support serialisation, this function should return false. A return value of true implies that the object was successfully saved to item. If canSerialize() returns false, this function must do nothing except return false as well.

Reimplemented from Glypher.

setDrawArrowHeads()

void setDrawArrowHeads

(

bool

b

)

setGlyphedModel()

void setGlyphedModel ( const Mesh::MeshModelInterface &  model )

overridevirtual

Parameters

model

The model about to be glyphed.

Subclasses can reimplement this function to save internal data about the model that will be used for subsequent calls to getGlyph(). Clients are free to call this function at any time, so the subclass must keep this in mind, although it will usually only be called by a model appearance processor just before it uses the glypher to process the specified model.

NOTE: Derived classes must call this base class's method.

Reimplemented from Glypher.

setLengthScale()

void setLengthScale

(

double

scale

)

setUseScaleAsLength()

void setUseScaleAsLength

(

bool

b

)

setVectorNodeMapper()

void setVectorNodeMapper

(

Mesh::VectorNodeMapper &

mapper

)