Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions
surface Class Reference
Inheritance diagram for surface:
Inheritance graph
[legend]
Collaboration diagram for surface:
Collaboration graph
[legend]

Public Types

enum  representationType {
  rtNone, rtWireframe, rtSurface, rtSurfaceWithEdges,
  rtGlyph
}
 
- Public Types inherited from geometryBase
enum  renderModeType { rmFlat, rmGouraud, rmPhong }
 

Public Member Functions

 TypeName ("surface")
 Run-time type information. More...
 
 declareRunTimeSelectionTable (autoPtr, surface, dictionary,(const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< DataEntry< vector >, word > &colours),(parent, dict, colours))
 
 surface (const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< DataEntry< vector >, word > &colours)
 Construct from dictionary. More...
 
virtual ~surface ()
 Destructor. More...
 
virtual void updateActors (const scalar position)
 Update the actors. 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 runTimePostProcessingparent () const
 Return the reference to the parent function object. More...
 
const wordname () 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...
 

Static Public Member Functions

static autoPtr< surfaceNew (const runTimePostProcessing &parent, const dictionary &dict, const HashPtrTable< DataEntry< vector >, word > &colours, const word &surfaceName)
 Return a reference to the selected RAS model. More...
 

Static Public Attributes

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

Protected Member Functions

void setRepresentation (vtkActor *actor) const
 Set the representation. More...
 
void addFeatureEdges (vtkRenderer *renderer, vtkPolyData *data) const
 Add feature edges to scene. More...
 
- Protected Member Functions inherited from geometryBase
void initialiseActor (vtkActor *actor) const
 Initialse actor. More...
 

Protected Attributes

representationType representation_
 Representation type. More...
 
bool featureEdges_
 Activate feature edges. More...
 
autoPtr< DataEntry< vector > > surfaceColour_
 Surface colour. More...
 
autoPtr< DataEntry< vector > > edgeColour_
 Edge colour. More...
 
vtkSmartPointer< vtkActor > surfaceActor_
 Surface actor. More...
 
vtkSmartPointer< vtkActor > edgeActor_
 Edge actor. More...
 
scalar maxGlyphLength_
 Max glyph length for representation type rtGlyph. More...
 
- Protected Attributes inherited from geometryBase
const runTimePostProcessingparent_
 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

 surface (const surface &)
 Disallow default bitwise copy construct. More...
 
void operator= (const surface &)
 Disallow default bitwise assignment. More...
 

Detailed Description

Source files

Definition at line 55 of file surface.H.

Member Enumeration Documentation

◆ representationType

Enumerator
rtNone 
rtWireframe 
rtSurface 
rtSurfaceWithEdges 
rtGlyph 

Definition at line 63 of file surface.H.

Constructor & Destructor Documentation

◆ surface() [1/2]

surface ( const surface )
private

Disallow default bitwise copy construct.

Referenced by meshOctreeCreator::createOctreeWithRefinedBoundary(), meshOctreeAutomaticRefinement::refineBasedOnContainedCorners(), and meshOctreeModifier::refineSelectedBoxes().

Here is the caller graph for this function:

◆ surface() [2/2]

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

Construct from dictionary.

Definition at line 135 of file surface.C.

References dict, dictionary::found(), dictionary::lookup(), and Foam::compressible::New().

Here is the call graph for this function:

◆ ~surface()

~surface ( )
virtual

Destructor.

Definition at line 222 of file surface.C.

Member Function Documentation

◆ operator=()

void operator= ( const surface )
private

Disallow default bitwise assignment.

◆ setRepresentation()

void setRepresentation ( vtkActor *  actor) const
protected

Set the representation.

Definition at line 63 of file surface.C.

References geometryBase::initialiseActor(), surface::representation_, surface::rtGlyph, surface::rtNone, surface::rtSurface, surface::rtSurfaceWithEdges, and surface::rtWireframe.

Here is the call graph for this function:

◆ addFeatureEdges()

void addFeatureEdges ( vtkRenderer *  renderer,
vtkPolyData *  data 
) const
protected

Add feature edges to scene.

Definition at line 97 of file surface.C.

References Foam::compressible::New().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "surface"  )

Run-time type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

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

Return a reference to the selected RAS model.

Definition at line 191 of file surface.C.

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

Here is the call graph for this function:

◆ updateActors()

void updateActors ( const scalar  position)
virtual

Update the actors.

Implements geometryBase.

Reimplemented in geometrySurface.

Definition at line 228 of file surface.C.

Referenced by geometrySurface::updateActors().

Here is the caller graph for this function:

Field Documentation

◆ representationTypeNames

const Foam::NamedEnum< Foam::surface::representationType, 5 > representationTypeNames
static

Definition at line 72 of file surface.H.

◆ representation_

representationType representation_
protected

Representation type.

Definition at line 91 of file surface.H.

Referenced by surface::setRepresentation().

◆ featureEdges_

bool featureEdges_
protected

Activate feature edges.

Definition at line 94 of file surface.H.

◆ surfaceColour_

autoPtr<DataEntry<vector> > surfaceColour_
protected

Surface colour.

Definition at line 97 of file surface.H.

◆ edgeColour_

autoPtr<DataEntry<vector> > edgeColour_
protected

Edge colour.

Definition at line 100 of file surface.H.

◆ surfaceActor_

vtkSmartPointer<vtkActor> surfaceActor_
protected

Surface actor.

Definition at line 103 of file surface.H.

◆ edgeActor_

vtkSmartPointer<vtkActor> edgeActor_
protected

Edge actor.

Definition at line 106 of file surface.H.

◆ maxGlyphLength_

scalar maxGlyphLength_
protected

Max glyph length for representation type rtGlyph.

Definition at line 109 of file surface.H.


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