pathline Class Reference

Inheritance diagram for pathline:

Collaboration diagram for pathline:

Public Types
enum	representationType { rtNone, rtLine, rtTube, rtVector }
Public Types inherited from geometryBase
enum	renderModeType { rmFlat, rmGouraud, rmPhong }

Public Member Functions
	TypeName ("pathline")
	Run-time type information. More...
	declareRunTimeSelectionTable (autoPtr, pathline, dictionary,(const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< DataEntry< vector >, word > &colours),(parent, dict, colours))
	pathline (const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< DataEntry< vector >, word > &colours)
	Construct from dictionary. More...
virtual	~pathline ()
	Destructor. More...
Public Member Functions inherited from geometryBase
	geometryBase (const runTimePostProcessing &parent_, const dictionary &dict, const HashPtrTable< DataEntry< vector >, word > &colours)
	Construct from dictionary. More...
virtual	~geometryBase ()
	Destructor. More...
const runTimePostProcessing &	parent () const
	Return the reference to the parent function object. More...
const word &	name () const
	Return the name. More...
bool	visible () const
	Return the visible flag. More...
scalar	opacity (const scalar position) const
	Return the opacity. More...
const HashPtrTable< DataEntry< vector >, word > &	colours () const
	Return reference to the colours. More...
virtual void	addGeometryToScene (const scalar position, vtkRenderer *renderer)=0
	Add geometry to scene. More...
virtual void	updateActors (const scalar position)=0
	Update the actors. More...

Static Public Member Functions
static autoPtr< pathline >	New (const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< DataEntry< vector >, word > &colours, const word &pathlineName)
	Return a reference to the selected RAS model. More...

Static Public Attributes
static const NamedEnum< representationType, 4 >	representationTypeNames
Static Public Attributes inherited from geometryBase
static const NamedEnum< renderModeType, 3 >	renderModeTypeNames

Protected Member Functions
void	addLines (const label frameI, vtkActor *actor, vtkPolyData *data) const
	Add the pathlines to the renderer. More...
Protected Member Functions inherited from geometryBase
void	initialiseActor (vtkActor *actor) const
	Initialse actor. More...

Protected Attributes
representationType	representation_
	Representation type. More...
scalar	tubeRadius_
	Radius for the tube filter. More...
autoPtr< DataEntry< vector > >	lineColour_
	Line colour. More...
Protected Attributes inherited from geometryBase
const runTimePostProcessing &	parent_
	Reference to the parent function object. More...
word	name_
	Name. More...
bool	visible_
	Visible flag. More...
renderModeType	renderMode_
	Render mode. More...
autoPtr< DataEntry< scalar > >	opacity_
	Opacity. More...
const HashPtrTable< DataEntry< vector >, word > &	colours_
	Reference to the colours. More...

Private Member Functions
	pathline (const pathline &)
	Disallow default bitwise copy construct. More...
void	operator= (const pathline &)
	Disallow default bitwise assignment. More...

Detailed Description

Source files

• pathline.H
• pathline.C

Definition at line 53 of file pathline.H.

Member Enumeration Documentation

representationType

enum representationType

Enumerator
rtNone
rtLine
rtTube
rtVector

Definition at line 61 of file pathline.H.

Constructor & Destructor Documentation

pathline() [1/2]

pathline ( const pathline &  )

private

Disallow default bitwise copy construct.

pathline() [2/2]

pathline	(	const runTimePostProcessing &	parent,
		const dictionary &	dict,
		const HashPtrTable< DataEntry< vector >, word > &	colours
	)

Construct from dictionary.

Definition at line 118 of file pathline.C.

References dict.

~pathline()

~pathline ( )

virtual

Destructor.

Definition at line 199 of file pathline.C.

Member Function Documentation

operator=()

void operator= ( const pathline &  )

private

Disallow default bitwise assignment.

addLines()

void addLines ( const label  frameI, vtkActor *  actor, vtkPolyData *  data  ) const

protected

Add the pathlines to the renderer.

Definition at line 63 of file pathline.C.

References Foam::compressible::New().

Here is the call graph for this function:

TypeName()

TypeName

(

"pathline"

)

Run-time type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		pathline	,
		dictionary	,
		(const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< DataEntry< vector >, word > &colours)	,
		(parent, dict, colours)
	)

New()

Foam::autoPtr< Foam::pathline > New ( const runTimePostProcessing &  parent, const dictionary &  dict, const HashPtrTable< DataEntry< vector >, word > &  colours, const word &  pathlineName  )

static

Return a reference to the selected RAS model.

Definition at line 168 of file pathline.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, and Foam::nl.

Here is the call graph for this function:

Field Documentation

representationTypeNames

const Foam::NamedEnum< Foam::pathline::representationType, 4 > representationTypeNames

static

Definition at line 69 of file pathline.H.

representation_

representationType representation_

protected

Representation type.

Definition at line 88 of file pathline.H.

tubeRadius_

scalar tubeRadius_

protected

Radius for the tube filter.

Definition at line 91 of file pathline.H.

lineColour_

autoPtr<DataEntry<vector> > lineColour_

protected

Line colour.

Definition at line 94 of file pathline.H.

---

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

• src/postProcessing/functionObjects/graphics/runTimePostProcessing/pathline.H
• src/postProcessing/functionObjects/graphics/runTimePostProcessing/pathline.C