Base class for surface, text handling etc. More...

Inheritance diagram for geometryBase:

Collaboration diagram for geometryBase:

Public Types
enum	renderModeType { rmFlat, rmGouraud, rmPhong }
	Surface shading types. More...

Public Member Functions
	geometryBase (const runTimePostProcessing &parent_, const dictionary &dict, const HashPtrTable< Function1< vector >> &colours)
	Construct from dictionary. More...

virtual	~geometryBase ()
	Destructor. More...

const runTimePostProcessing &	parent () const
	Return the reference to the parent function object. More...

bool	needsCollective () const
	May need to gather geometry parts to render on single-processor. More...

const word &	name () const
	Return the name. More...

bool	visible () const
	Return the visible flag. More...

bool	parallel () const
	Allow parallel rendering. More...

scalar	opacity (const scalar position) const
	Return the opacity. More...

const HashPtrTable< Function1< vector > > &	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...

virtual bool	clear ()=0
	Clear any files used to create the object(s) More...

Static Public Attributes
static const Enum< renderModeType >	renderModeTypeNames
	Names for surface shading types. More...

static int	debug
	Debug switch. More...

Protected Member Functions
void	initialiseActor (vtkActor *actor) const
	Initialise actor. More...

	geometryBase (const geometryBase &)=delete
	No copy construct. More...

void	operator= (const geometryBase &)=delete
	No copy assignment. More...

Protected Attributes
const runTimePostProcessing &	parent_
	Reference to the parent function object. More...

word	name_
	The surface name. More...

bool	visible_
	Visible flag. More...

bool	parallel_
	Allow parallel rendering. More...

renderModeType	renderMode_
	Render mode. More...

autoPtr< Function1< scalar > >	opacity_
	Opacity. More...

const HashPtrTable< Function1< vector > > &	colours_
	Reference to the colours. More...

Detailed Description

Base class for surface, text handling etc.

Dictionary controls

Property	Description	Required	Default
`visible`	Display the object	no	yes
`renderMode`	Shading (flat/gouraud/phong)	no	gouraud
`opacity`	Object opacity	no	1.0
`parallel`	Allow parallel rendering	no	true

Source files

Definition at line 101 of file geometryBase.H.

Member Enumeration Documentation

◆ renderModeType

enum renderModeType

Surface shading types.

Enumerator
rmFlat	Flat shading.
rmGouraud	Gouraud shading.
rmPhong	Phong shading.

Definition at line 108 of file geometryBase.H.

Constructor & Destructor Documentation

◆ geometryBase() [1/2]

geometryBase ( const geometryBase & )

protecteddelete

No copy construct.

◆ geometryBase() [2/2]

geometryBase	(	const runTimePostProcessing &	parent_,
		const dictionary &	dict,
		const HashPtrTable< Function1< vector >> &	colours
	)

Construct from dictionary.

Definition at line 95 of file geometryBase.C.

References dict.

◆ ~geometryBase()

~geometryBase ( )

virtual

Destructor.

Definition at line 134 of file geometryBase.C.

Member Function Documentation

◆ initialiseActor()

void initialiseActor ( vtkActor * actor ) const

protected

Initialise actor.

Definition at line 64 of file geometryBase.C.

◆ operator=()

void operator= ( const geometryBase & )

protecteddelete

No copy assignment.

◆ parent()

const Foam::functionObjects::runTimePostProcessing & parent ( ) const

Return the reference to the parent function object.

Definition at line 141 of file geometryBase.C.

◆ needsCollective()

bool needsCollective ( ) const

May need to gather geometry parts to render on single-processor.

True when OpenFOAM is running in parallel but VTK is not.

Definition at line 148 of file geometryBase.C.

References UPstream::parRun().

Here is the call graph for this function:

◆ name()

const Foam::word & name ( ) const

Return the name.

Definition at line 155 of file geometryBase.C.

◆ visible()

bool visible ( ) const

inline

Return the visible flag.

Definition at line 190 of file geometryBase.H.

References geometryBase::visible_.

◆ parallel()

bool parallel ( ) const

inline

Allow parallel rendering.

Definition at line 196 of file geometryBase.H.

References geometryBase::parallel_.

◆ opacity()

Foam::scalar opacity ( const scalar position ) const

Return the opacity.

Definition at line 162 of file geometryBase.C.

◆ colours()

const Foam::HashPtrTable< Foam::Function1< Foam::vector >, Foam::word > & colours ( ) const

Return reference to the colours.

Definition at line 171 of file geometryBase.C.

◆ addGeometryToScene()

virtual void addGeometryToScene	(	const scalar	position,
		vtkRenderer *	renderer
	)

pure virtual

Add geometry to scene.

Implemented in text, geometryCloud, cuttingPlaneFilter, functionObjectCloud, geometryPatches, contourFilter, geometrySurface, functionObjectSurface, and functionObjectLine.

◆ updateActors()

virtual void updateActors ( const scalar position )

pure virtual

Update the actors.

Implemented in surface, text, geometryCloud, functionObjectCloud, geometryPatches, geometrySurface, and functionObjectLine.

◆ clear()

virtual bool clear ( )

pure virtual

Clear any files used to create the object(s)

Implemented in text, geometryCloud, cuttingPlaneFilter, functionObjectCloud, geometryPatches, geometrySurface, contourFilter, functionObjectSurface, and functionObjectLine.

Member Data Documentation

◆ renderModeTypeNames

const Foam::Enum< Foam::functionObjects::runTimePostPro::geometryBase::renderModeType > renderModeTypeNames

static

Names for surface shading types.

Definition at line 116 of file geometryBase.H.

◆ parent_

const runTimePostProcessing& parent_

protected

Reference to the parent function object.

Definition at line 124 of file geometryBase.H.

Referenced by text::addGeometryToScene().

◆ name_

word name_

protected

The surface name.

Definition at line 127 of file geometryBase.H.

◆ visible_

bool visible_

protected

Visible flag.

Definition at line 130 of file geometryBase.H.

Referenced by geometryBase::visible().

◆ parallel_

bool parallel_

protected

Allow parallel rendering.

Definition at line 133 of file geometryBase.H.

Referenced by geometryBase::parallel().

◆ renderMode_

renderModeType renderMode_

protected

Render mode.

Definition at line 136 of file geometryBase.H.

◆ opacity_

autoPtr<Function1<scalar> > opacity_

protected

Opacity.

Definition at line 139 of file geometryBase.H.

◆ colours_

const HashPtrTable<Function1<vector> >& colours_

protected

Reference to the colours.

Definition at line 142 of file geometryBase.H.

◆ debug

int debug

static

Debug switch.

Definition at line 160 of file geometryBase.H.

Referenced by runTimePostProcessing::read().

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

src/functionObjects/graphics/runTimePostProcessing/geometryBase.H
src/functionObjects/graphics/runTimePostProcessing/geometryBase.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ renderModeType

Constructor & Destructor Documentation

◆ geometryBase() [1/2]

◆ geometryBase() [2/2]

◆ ~geometryBase()

Member Function Documentation

◆ initialiseActor()

◆ operator=()

◆ parent()

◆ needsCollective()

◆ name()

◆ visible()

◆ parallel()

◆ opacity()

◆ colours()

◆ addGeometryToScene()

◆ updateActors()

◆ clear()

Member Data Documentation

◆ renderModeTypeNames

◆ parent_

◆ name_

◆ visible_

◆ parallel_

◆ renderMode_

◆ opacity_

◆ colours_

◆ debug