pointData Class Reference

Visualisation of point data. More...

Inheritance diagram for pointData:
[legend]
Collaboration diagram for pointData:
[legend]

Public Types

enum  representationType { rtSphere, rtVector }
 Point representation types. More...
 
- Public Types inherited from geometryBase
enum  renderModeType { rmFlat, rmGouraud, rmPhong }
 Surface shading types. More...
 

Public Member Functions

 TypeNameNoDebug ("pointData")
 Run-time type information. More...
 
 declareRunTimeSelectionTable (autoPtr, pointData, dictionary,(const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< Function1< vector >> &colours),(parent, dict, colours))
 
 pointData (const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< Function1< vector >> &colours)
 Construct from dictionary. More...
 
virtual ~pointData ()
 Destructor. More...
 
- Public Member Functions inherited from geometryBase
 geometryBase (const runTimePostProcessing &parent_, const dictionary &dict, const HashPtrTable< Function1< vector >> &colours)
 Construct from dictionary. More...
 
virtual ~geometryBase ()
 Destructor. More...
 
const runTimePostProcessingparent () 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 wordname () 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 Member Functions

static autoPtr< pointDataNew (const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< Function1< vector >> &colours, const word &pointDataName)
 Return selected pointData. More...
 

Static Public Attributes

static const Enum< representationTyperepresentationTypeNames
 Names for point representation types. More...
 
- Static Public Attributes inherited from geometryBase
static const Enum< renderModeTyperenderModeTypeNames
 Names for surface shading types. More...
 
static int debug
 Debug switch. More...
 

Protected Member Functions

void addPoints (const label framei, vtkActor *actor, vtkPolyDataMapper *mapper, vtkPolyData *data) const
 Add the point data to the renderer. More...
 
 pointData (const pointData &)=delete
 No copy construct. More...
 
void operator= (const pointData &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from geometryBase
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

representationType representation_
 Representation type. More...
 
scalar maxGlyphLength_
 Max glyph length. More...
 
autoPtr< Function1< vector > > pointColour_
 Point colour. More...
 
- Protected Attributes inherited from geometryBase
const runTimePostProcessingparent_
 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

Visualisation of point data.

Dictionary controls

Property Description Required Default
representation sphere/vector yes
pointColour Override point colour no
maxGlyphLength Limit for glyph representation yes
Source files

Definition at line 89 of file pointData.H.

Member Enumeration Documentation

◆ representationType

Point representation types.

Enumerator
rtSphere 

"sphere"

rtVector 

"vector"

Definition at line 98 of file pointData.H.

Constructor & Destructor Documentation

◆ pointData() [1/2]

pointData ( const pointData )
protecteddelete

No copy construct.

◆ pointData() [2/2]

pointData ( const runTimePostProcessing parent,
const dictionary dict,
const HashPtrTable< Function1< vector >> &  colours 
)

Construct from dictionary.

Definition at line 93 of file pointData.C.

References dict.

◆ ~pointData()

~pointData ( )
virtual

Destructor.

Definition at line 163 of file pointData.C.

Member Function Documentation

◆ addPoints()

void addPoints ( const label  framei,
vtkActor *  actor,
vtkPolyDataMapper *  mapper,
vtkPolyData *  data 
) const
protected

Add the point data to the renderer.

Definition at line 67 of file pointData.C.

◆ operator=()

void operator= ( const pointData )
protecteddelete

No copy assignment.

◆ TypeNameNoDebug()

TypeNameNoDebug ( "pointData"  )

Run-time type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
pointData  ,
dictionary  ,
(const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< Function1< vector >> &colours ,
(parent, dict, colours  
)

◆ New()

Foam::autoPtr< Foam::functionObjects::runTimePostPro::pointData > New ( const runTimePostProcessing parent,
const dictionary dict,
const HashPtrTable< Function1< vector >> &  colours,
const word pointDataName 
)
static

Return selected pointData.

Definition at line 135 of file pointData.C.

References DebugInfo, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, and FatalIOErrorInLookup.

Here is the call graph for this function:

Member Data Documentation

◆ representationTypeNames

Names for point representation types.

Definition at line 105 of file pointData.H.

◆ representation_

representationType representation_
protected

Representation type.

Definition at line 113 of file pointData.H.

◆ maxGlyphLength_

scalar maxGlyphLength_
protected

Max glyph length.

Definition at line 116 of file pointData.H.

◆ pointColour_

autoPtr<Function1<vector> > pointColour_
protected

Point colour.

Definition at line 119 of file pointData.H.


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