StreakGlypher Class Reference

Glypher that produces streaks at each node of a model. More...

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

Inheritance diagram for StreakGlypher:

Public Member Functions
	StreakGlypher ()
	StreakGlypher (const StreakGlypher &glypher)
	~StreakGlypher () override
StreakGlypher *	clone () const override
const QString &	getColorStateName () const
const QColor &	getDefaultColor () const
double	getDefaultRadius () const
bool	getDrawAsTrailing () const
Glyph	getGlyph (const Mesh::NodeHandle &node) override
	Returns the glyph for the specified node in the mesh being glyphed.
int	getLevelOfDetail () const
double	getMaxZLength () const
Mesh::MeshModelLibrary &	getMeshModelLibrary () override
const DataExecution::ObjectDictionary &	getParticleTimeline () const
const QString &	getPositionStateName () const
const QString &	getRadiusStateName () const
double	getScale () const
bool	load (const DataExecution::SerializedItem &item) override
	Load the streak glypher's properties from a serialized item.
StreakGlypher &	operator= (const StreakGlypher &glypher)
bool	save (DataExecution::SerializedItem &item) const override
	Save the streak glypher's properties to a SerializedItem.
void	setColorStateName (const QString &name)
void	setDefaultColor (const QColor &color)
void	setDefaultRadius (double r)
void	setDrawAsTrailing (bool drawAsTrailing)
void	setGlyphedModel (const Mesh::MeshModelInterface &model) override
	Sets the model being glyphed.
void	setLevelOfDetail (int lod)
void	setMaxZLength (double maxLength)
void	setParticleTimeline (const DataExecution::ObjectDictionary &timeline)
void	setPositionStateName (const QString &name)
void	setRadiusStateName (const QString &name)
void	setScale (double)
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

Streaks represent the distance that the particle has travelled over time. The time / sampling rate used for each streak is determined by the particle timeline passed into the file.

See also

Mesh::AppendToModelTimeline

Constructor & Destructor Documentation

StreakGlypher() [1/2]

StreakGlypher

(

)

StreakGlypher() [2/2]

StreakGlypher

(

const StreakGlypher &

glypher

)

~StreakGlypher()

~StreakGlypher ( )

override

Member Function Documentation

clone()

StreakGlypher * 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.

getColorStateName()

const QString & getColorStateName

(

)

const

getDefaultColor()

const QColor & getDefaultColor

(

)

const

Returns

The default color associated with each streak.

getDefaultRadius()

double getDefaultRadius

(

)

const

getDrawAsTrailing()

bool getDrawAsTrailing

(

)

const

getGlyph()

Glyph getGlyph ( const Mesh::NodeHandle &  node )

overridevirtual

Parameters

node	The node for which we are retrieving the streak glyph.

Returns

The streak glyph associated with the provided node.

Implements Glypher.

getLevelOfDetail()

int getLevelOfDetail

(

)

const

Returns

The level of detail currently applied to streaks produced by the glypher.

getMaxZLength()

double getMaxZLength

(

)

const

getMeshModelLibrary()

Mesh::MeshModelLibrary & getMeshModelLibrary ( )

overridevirtual

Returns

The meshmodellibrary which contains the mesh-data for any glyphs used.

Implements Glypher.

getParticleTimeline()

const DataCollection & getParticleTimeline

(

)

const

getPositionStateName()

const QString & getPositionStateName

(

)

const

getRadiusStateName()

const QString & getRadiusStateName

(

)

const

getScale()

double getScale

(

)

const

load()

bool load ( const DataExecution::SerializedItem &  item )

overridevirtual

Parameters

item	The SerializedItem from which to load the streak glypher's properties.

Returns

True if the loading operation was successful, false otherwise.

Reimplemented from Glypher.

operator=()

StreakGlypher & operator=

(

const StreakGlypher &

glypher

)

save()

bool save ( DataExecution::SerializedItem &  item ) const

overridevirtual

Parameters

item	The item to which we are using to serialize the glypher's properties.

Returns

True if the save was successful, false if an error occurred.

Reimplemented from Glypher.

setColorStateName()

void setColorStateName

(

const QString &

name

)

setDefaultColor()

void setDefaultColor

(

const QColor &

color

)

Parameters

color

The default color associated with each glyph.

setDefaultRadius()

void setDefaultRadius

(

double

r

)

setDrawAsTrailing()

void setDrawAsTrailing

(

bool

drawAsTrailing

)

setGlyphedModel()

void setGlyphedModel ( const Mesh::MeshModelInterface &  model )

overridevirtual

Parameters

model

The model which we are about to glyph.

Reimplemented from Glypher.

setLevelOfDetail()

void setLevelOfDetail

(

int

lod

)

Parameters

lod	The level of detail to be applied to streak glyphs. Higher numbers will produce better looking streaks, but lower numbers will improve performance.

setMaxZLength()

void setMaxZLength

(

double

maxLength

)

setParticleTimeline()

void setParticleTimeline

(

const DataExecution::ObjectDictionary &

timeline

)

setPositionStateName()

void setPositionStateName

(

const QString &

name

)

setRadiusStateName()

void setRadiusStateName

(

const QString &

name

)

setScale()

void setScale

(

double

scale

)