ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkGlyph3DRepresentation Class Reference

vtkGlyph3DRepresentation is a representation that uses the vtkGlyph3DMapper for rendering glyphs. More...

#include <vtkGlyph3DRepresentation.h>

Inheritance diagram for vtkGlyph3DRepresentation:
Inheritance graph
[legend]
Collaboration diagram for vtkGlyph3DRepresentation:
Collaboration graph
[legend]

Public Types

typedef vtkGeometryRepresentation Superclass
 
- Public Types inherited from vtkGeometryRepresentation
enum  RepresentationTypes { POINTS = VTK_POINTS, WIREFRAME = VTK_WIREFRAME, SURFACE = VTK_SURFACE, SURFACE_WITH_EDGES = 3 }
 
typedef vtkPVDataRepresentation Superclass
 
- Public Types inherited from vtkPVDataRepresentation
typedef vtkDataRepresentation Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
 vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...
 
void SetMeshVisibility (bool visible)
 Toggle the visibility of the original mesh. More...
 
virtual void SetVisibility (bool)
 Get/Set the visibility for this representation. More...
 
void SetMaskArray (const char *val)
 
void SetScaleArray (const char *val)
 
void SetOrientationArray (const char *val)
 
void SetScaling (bool val)
 
void SetScaleMode (int val)
 
void SetScaleFactor (double val)
 
void SetOrient (bool val)
 
void SetOrientationMode (int val)
 
void SetMasking (bool val)
 
virtual void SetInterpolateScalarsBeforeMapping (int val)
 
virtual void SetLookupTable (vtkScalarsToColors *val)
 
virtual void SetMapScalars (int val)
 Sets if scalars are mapped through a color-map or are used directly as colors. More...
 
virtual void SetStatic (int val)
 Sets if scalars are mapped through a color-map or are used directly as colors. More...
 
virtual void SetOrientation (double, double, double)
 
virtual void SetOrigin (double, double, double)
 
virtual void SetPickable (int val)
 
virtual void SetPosition (double, double, double)
 
virtual void SetScale (double, double, double)
 
virtual void SetTexture (vtkTexture *)
 
virtual void SetUserTransform (const double[16])
 
- Public Member Functions inherited from vtkGeometryRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void MarkModified ()
 This needs to be called on all instances of vtkGeometryRepresentation when the input is modified. More...
 
virtual void SetSuppressLOD (bool suppress)
 Enable/Disable LOD;. More...
 
virtual void SetRepresentation (const char *)
 Overload to set representation type using string. More...
 
virtual vtkDataObject * GetRenderedDataObject (int port)
 Returns the data object that is rendered from the given input port. More...
 
virtual void SetUseOutline (int)
 
void SetTriangulate (int)
 
void SetNonlinearSubdivisionLevel (int)
 
virtual void SetAmbientColor (double r, double g, double b)
 
virtual void SetColor (double r, double g, double b)
 
virtual void SetDiffuseColor (double r, double g, double b)
 
virtual void SetEdgeColor (double r, double g, double b)
 
virtual void SetInterpolation (int val)
 
virtual void SetLineWidth (double val)
 
virtual void SetOpacity (double val)
 
virtual void SetPointSize (double val)
 
virtual void SetSpecularColor (double r, double g, double b)
 
virtual void SetSpecularPower (double val)
 
vtkPVLODActorGetActor ()
 Provides access to the actor used by this representation. More...
 
const char * GetColorArrayName ()
 Convenience method to get the array name used to scalar color with. More...
 
void SetBlockColorsDistinctValues (int distinctValues)
 Determines the number of distinct values in vtkBlockColors See also vtkPVGeometryFilter. More...
 
int GetBlockColorsDistinctValues ()
 Determines the number of distinct values in vtkBlockColors See also vtkPVGeometryFilter. More...
 
virtual void SetAmbient (double)
 Set the lighting properties of the object. More...
 
virtual void SetDiffuse (double)
 Set the lighting properties of the object. More...
 
virtual void SetSpecular (double)
 Set the lighting properties of the object. More...
 
virtual double GetAmbient ()
 Set the lighting properties of the object. More...
 
virtual double GetDiffuse ()
 Set the lighting properties of the object. More...
 
virtual double GetSpecular ()
 Set the lighting properties of the object. More...
 
virtual void SetRepresentation (int)
 Set the representation type. More...
 
virtual int GetRepresentation ()
 Set the representation type. More...
 
virtual void SetRequestGhostCellsIfNeeded (bool)
 Representations that use geometry representation as the internal representation should turn this flag off so that we don't end up requesting ghost cells twice. More...
 
virtual bool GetRequestGhostCellsIfNeeded ()
 Representations that use geometry representation as the internal representation should turn this flag off so that we don't end up requesting ghost cells twice. More...
 
virtual void RequestGhostCellsIfNeededOn ()
 Representations that use geometry representation as the internal representation should turn this flag off so that we don't end up requesting ghost cells twice. More...
 
virtual void RequestGhostCellsIfNeededOff ()
 Representations that use geometry representation as the internal representation should turn this flag off so that we don't end up requesting ghost cells twice. More...
 
virtual void SetBlockVisibility (unsigned int index, bool visible)
 Set/get the visibility for a single block. More...
 
virtual bool GetBlockVisibility (unsigned int index) const
 Set/get the visibility for a single block. More...
 
virtual void RemoveBlockVisibility (unsigned int index, bool=true)
 Set/get the visibility for a single block. More...
 
virtual void RemoveBlockVisibilities ()
 Set/get the visibility for a single block. More...
 
virtual void SetBlockColor (unsigned int index, double r, double g, double b)
 Set/get the color for a single block. More...
 
virtual void SetBlockColor (unsigned int index, double *color)
 Set/get the color for a single block. More...
 
virtual double * GetBlockColor (unsigned int index)
 Set/get the color for a single block. More...
 
virtual void RemoveBlockColor (unsigned int index)
 Set/get the color for a single block. More...
 
virtual void RemoveBlockColors ()
 Set/get the color for a single block. More...
 
virtual void SetBlockOpacity (unsigned int index, double opacity)
 Set/get the opacityfor a single block. More...
 
virtual void SetBlockOpacity (unsigned int index, double *opacity)
 Set/get the opacityfor a single block. More...
 
virtual double GetBlockOpacity (unsigned int index)
 Set/get the opacityfor a single block. More...
 
virtual void RemoveBlockOpacity (unsigned int index)
 Set/get the opacityfor a single block. More...
 
virtual void RemoveBlockOpacities ()
 Set/get the opacityfor a single block. More...
 
virtual void SetEnableScaling (int v)
 For OSPRay controls sizing of implicit spheres (points) and cylinders (lines) More...
 
virtual void SetScalingArrayName (const char *)
 For OSPRay controls sizing of implicit spheres (points) and cylinders (lines) More...
 
virtual void SetScalingFunction (vtkPiecewiseFunction *pwf)
 For OSPRay controls sizing of implicit spheres (points) and cylinders (lines) More...
 
virtual void SetUseDataPartitions (bool)
 Specify whether or not to redistribute the data. More...
 
virtual bool GetUseDataPartitions ()
 Specify whether or not to redistribute the data. More...
 
- Public Member Functions inherited from vtkPVDataRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual unsigned int Initialize (unsigned int minIdAvailable, unsigned int maxIdAvailable)
 Initialize the representation with an identifier range so each internal representation can own a unique ID. More...
 
unsigned int GetUniqueIdentifier ()
 Return 0 if the Initialize() method was not called otherwise a unique ID that will be shared across the processes for that same object. More...
 
virtual bool GetVisibility ()
 
virtual vtkDataObject * GetRenderedDataObject (int vtkNotUsed(port))
 Returns the data object that is rendered from the given input port. More...
 
virtual void SetForcedCacheKey (double val)
 Typically a representation decides whether to use cache based on the view's values for UseCache and CacheKey. More...
 
virtual void SetForceUseCache (bool val)
 
bool GetUsingCacheForUpdate ()
 Called by vtkPVDataRepresentationPipeline to see if using cache is valid and will be used for the update. More...
 
virtual bool GetNeedUpdate ()
 
virtual vtkAlgorithmOutput * GetInternalOutputPort ()
 Retrieves an output port for the input data object at the specified port and connection index. More...
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port)
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port, int conn)
 
vtkView * GetView () const
 Provides access to the view. More...
 
virtual void SetUpdateTime (double time)
 Set the update time. More...
 
virtual double GetUpdateTime ()
 Set the update time. More...
 
virtual bool GetUpdateTimeValid ()
 Set whether the UpdateTime is valid. More...
 
virtual void SetUseCache (bool)
 
virtual void SetCacheKey (double val)
 
virtual double GetCacheKey ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 
virtual bool GetUseCache ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 

Static Public Member Functions

static vtkGlyph3DRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGlyph3DRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkGeometryRepresentation
static vtkGeometryRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGeometryRepresentationSafeDownCast (vtkObject *o)
 
static bool DoRequestGhostCells (vtkInformation *information)
 Returns true if this class would like to get ghost-cells if available for the connection whose information object is passed as the argument. More...
 
static bool GetBounds (vtkDataObject *dataObject, double bounds[6], vtkCompositeDataDisplayAttributes *cdAttributes)
 Convenience method to get bounds from a dataset/composite dataset. More...
 
- Static Public Member Functions inherited from vtkPVDataRepresentation
static int IsTypeOf (const char *type)
 
static vtkPVDataRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkGlyph3DRepresentation ()
 
 ~vtkGlyph3DRepresentation ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill input port information. More...
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Subclasses should override this to connect inputs to the internal pipeline as necessary. More...
 
int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) VTK_OVERRIDE
 Overridden to request single piece from the Glyph source. More...
 
virtual bool AddToView (vtkView *view)
 Adds the representation to the view. More...
 
virtual bool RemoveFromView (vtkView *view)
 Removes the representation to the view. More...
 
virtual vtkPVLODActorGetRenderedProp ()
 Used in ConvertSelection to locate the prop used for actual rendering. More...
 
virtual void UpdateColoringParameters ()
 Overridden to ensure that the coloring decisions are passed over to the glyph mapper. More...
 
void ComputeGlyphBounds (double bounds[6])
 Determines bounds using the vtkGlyph3DMapper. More...
 
- Protected Member Functions inherited from vtkGeometryRepresentation
 vtkGeometryRepresentation ()
 
 ~vtkGeometryRepresentation ()
 
virtual void SetupDefaults ()
 This method is called in the constructor. More...
 
virtual bool GenerateMetaData (vtkInformation *, vtkInformation *)
 Produce meta-data about this representation that the view may find useful. More...
 
virtual bool IsCached (double cache_key)
 Overridden to check with the vtkPVCacheKeeper to see if the key is cached. More...
 
- Protected Member Functions inherited from vtkPVDataRepresentation
 vtkPVDataRepresentation ()
 
 ~vtkPVDataRepresentation ()
 
virtual vtkExecutive * CreateDefaultExecutive ()
 Create a default executive. More...
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

vtkGlyph3DMapper * GlyphMapper
 
vtkGlyph3DMapper * LODGlyphMapper
 
vtkPVLODActorGlyphActor
 
vtkPVArrowSourceDummySource
 
bool MeshVisibility
 
- Protected Attributes inherited from vtkGeometryRepresentation
vtkAlgorithm * GeometryFilter
 
vtkAlgorithm * MultiBlockMaker
 
vtkPVCacheKeeperCacheKeeper
 
vtkQuadricClustering * Decimator
 
vtkPVGeometryFilterLODOutlineFilter
 
vtkMapper * Mapper
 
vtkMapper * LODMapper
 
vtkPVLODActorActor
 
vtkProperty * Property
 
double Ambient
 
double Specular
 
double Diffuse
 
int Representation
 
bool SuppressLOD
 
bool RequestGhostCellsIfNeeded
 
double DataBounds [6]
 
vtkPiecewiseFunction * PWF
 
bool UseDataPartitions
 
- Protected Attributes inherited from vtkPVDataRepresentation
double UpdateTime
 
bool UpdateTimeValid
 
unsigned int UniqueIdentifier
 

Detailed Description

vtkGlyph3DRepresentation is a representation that uses the vtkGlyph3DMapper for rendering glyphs.

Note that vtkGlyph3DRepresentation requires that the "glyph" source data is available on all rendering processes.

Definition at line 33 of file vtkGlyph3DRepresentation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 of file vtkGlyph3DRepresentation.h.

Constructor & Destructor Documentation

◆ vtkGlyph3DRepresentation()

vtkGlyph3DRepresentation::vtkGlyph3DRepresentation ( )
protected

◆ ~vtkGlyph3DRepresentation()

vtkGlyph3DRepresentation::~vtkGlyph3DRepresentation ( )
protected

Member Function Documentation

◆ New()

static vtkGlyph3DRepresentation* vtkGlyph3DRepresentation::New ( )
static

◆ GetClassName()

virtual const char* vtkGlyph3DRepresentation::GetClassName ( )
virtual

Reimplemented from vtkGeometryRepresentation.

◆ IsTypeOf()

static int vtkGlyph3DRepresentation::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkGlyph3DRepresentation::IsA ( const char *  type)
virtual

Reimplemented from vtkGeometryRepresentation.

◆ SafeDownCast()

static vtkGlyph3DRepresentation* vtkGlyph3DRepresentation::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

void vtkGlyph3DRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ ProcessViewRequest()

virtual int vtkGlyph3DRepresentation::ProcessViewRequest ( vtkInformationRequestKey *  request_type,
vtkInformation *  inInfo,
vtkInformation *  outInfo 
)
virtual

vtkAlgorithm::ProcessRequest() equivalent for rendering passes.

This is typically called by the vtkView to request meta-data from the representations or ask them to perform certain tasks e.g. PrepareForRendering.

Reimplemented from vtkGeometryRepresentation.

◆ SetMeshVisibility()

void vtkGlyph3DRepresentation::SetMeshVisibility ( bool  visible)

Toggle the visibility of the original mesh.

If this->GetVisibility() is false, then this has no effect.

◆ SetVisibility()

virtual void vtkGlyph3DRepresentation::SetVisibility ( bool  )
virtual

Get/Set the visibility for this representation.

When the visibility of representation of false, all view passes are ignored.

Reimplemented from vtkGeometryRepresentation.

◆ SetMaskArray()

void vtkGlyph3DRepresentation::SetMaskArray ( const char *  val)

◆ SetScaleArray()

void vtkGlyph3DRepresentation::SetScaleArray ( const char *  val)

◆ SetOrientationArray()

void vtkGlyph3DRepresentation::SetOrientationArray ( const char *  val)

◆ SetScaling()

void vtkGlyph3DRepresentation::SetScaling ( bool  val)

◆ SetScaleMode()

void vtkGlyph3DRepresentation::SetScaleMode ( int  val)

◆ SetScaleFactor()

void vtkGlyph3DRepresentation::SetScaleFactor ( double  val)

◆ SetOrient()

void vtkGlyph3DRepresentation::SetOrient ( bool  val)

◆ SetOrientationMode()

void vtkGlyph3DRepresentation::SetOrientationMode ( int  val)

◆ SetMasking()

void vtkGlyph3DRepresentation::SetMasking ( bool  val)

◆ SetInterpolateScalarsBeforeMapping()

virtual void vtkGlyph3DRepresentation::SetInterpolateScalarsBeforeMapping ( int  val)
virtual

Reimplemented from vtkGeometryRepresentation.

◆ SetLookupTable()

virtual void vtkGlyph3DRepresentation::SetLookupTable ( vtkScalarsToColors *  val)
virtual

Reimplemented from vtkGeometryRepresentation.

◆ SetMapScalars()

virtual void vtkGlyph3DRepresentation::SetMapScalars ( int  val)
virtual

Sets if scalars are mapped through a color-map or are used directly as colors.

0 maps to VTK_COLOR_MODE_DIRECT_SCALARS 1 maps to VTK_COLOR_MODE_MAP_SCALARS

See also
vtkScalarsToColors::MapScalars

Reimplemented from vtkGeometryRepresentation.

◆ SetStatic()

virtual void vtkGlyph3DRepresentation::SetStatic ( int  val)
virtual

Sets if scalars are mapped through a color-map or are used directly as colors.

0 maps to VTK_COLOR_MODE_DIRECT_SCALARS 1 maps to VTK_COLOR_MODE_MAP_SCALARS

See also
vtkScalarsToColors::MapScalars

Reimplemented from vtkGeometryRepresentation.

◆ SetOrientation()

virtual void vtkGlyph3DRepresentation::SetOrientation ( double  ,
double  ,
double   
)
virtual

Reimplemented from vtkGeometryRepresentation.

◆ SetOrigin()

virtual void vtkGlyph3DRepresentation::SetOrigin ( double  ,
double  ,
double   
)
virtual

Reimplemented from vtkGeometryRepresentation.

◆ SetPickable()

virtual void vtkGlyph3DRepresentation::SetPickable ( int  val)
virtual

Reimplemented from vtkGeometryRepresentation.

◆ SetPosition()

virtual void vtkGlyph3DRepresentation::SetPosition ( double  ,
double  ,
double   
)
virtual

Reimplemented from vtkGeometryRepresentation.

◆ SetScale()

virtual void vtkGlyph3DRepresentation::SetScale ( double  ,
double  ,
double   
)
virtual

Reimplemented from vtkGeometryRepresentation.

◆ SetTexture()

virtual void vtkGlyph3DRepresentation::SetTexture ( vtkTexture *  )
virtual

Reimplemented from vtkGeometryRepresentation.

◆ SetUserTransform()

virtual void vtkGlyph3DRepresentation::SetUserTransform ( const double  [16])
virtual

Reimplemented from vtkGeometryRepresentation.

◆ FillInputPortInformation()

virtual int vtkGlyph3DRepresentation::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Fill input port information.

Reimplemented from vtkGeometryRepresentation.

◆ RequestData()

virtual int vtkGlyph3DRepresentation::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Subclasses should override this to connect inputs to the internal pipeline as necessary.

Since most representations are "meta-filters" (i.e. filters containing other filters), you should create shallow copies of your input before connecting to the internal pipeline. The convenience method GetInternalOutputPort will create a cached shallow copy of a specified input for you. The related helper functions GetInternalAnnotationOutputPort, GetInternalSelectionOutputPort should be used to obtain a selection or annotation port whose selections are localized for a particular input data object.

Reimplemented from vtkGeometryRepresentation.

◆ RequestUpdateExtent()

int vtkGlyph3DRepresentation::RequestUpdateExtent ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Overridden to request single piece from the Glyph source.

Reimplemented from vtkGeometryRepresentation.

◆ AddToView()

virtual bool vtkGlyph3DRepresentation::AddToView ( vtkView *  view)
protectedvirtual

Adds the representation to the view.

This is called from vtkView::AddRepresentation(). Subclasses should override this method. Returns true if the addition succeeds.

Reimplemented from vtkGeometryRepresentation.

◆ RemoveFromView()

virtual bool vtkGlyph3DRepresentation::RemoveFromView ( vtkView *  view)
protectedvirtual

Removes the representation to the view.

This is called from vtkView::RemoveRepresentation(). Subclasses should override this method. Returns true if the removal succeeds.

Reimplemented from vtkGeometryRepresentation.

◆ GetRenderedProp()

virtual vtkPVLODActor* vtkGlyph3DRepresentation::GetRenderedProp ( )
inlineprotectedvirtual

Used in ConvertSelection to locate the prop used for actual rendering.

Reimplemented from vtkGeometryRepresentation.

Definition at line 125 of file vtkGlyph3DRepresentation.h.

◆ UpdateColoringParameters()

virtual void vtkGlyph3DRepresentation::UpdateColoringParameters ( )
protectedvirtual

Overridden to ensure that the coloring decisions are passed over to the glyph mapper.

Reimplemented from vtkGeometryRepresentation.

◆ ComputeGlyphBounds()

void vtkGlyph3DRepresentation::ComputeGlyphBounds ( double  bounds[6])
protected

Determines bounds using the vtkGlyph3DMapper.

Member Data Documentation

◆ GlyphMapper

vtkGlyph3DMapper* vtkGlyph3DRepresentation::GlyphMapper
protected

Definition at line 138 of file vtkGlyph3DRepresentation.h.

◆ LODGlyphMapper

vtkGlyph3DMapper* vtkGlyph3DRepresentation::LODGlyphMapper
protected

Definition at line 139 of file vtkGlyph3DRepresentation.h.

◆ GlyphActor

vtkPVLODActor* vtkGlyph3DRepresentation::GlyphActor
protected

Definition at line 141 of file vtkGlyph3DRepresentation.h.

◆ DummySource

vtkPVArrowSource* vtkGlyph3DRepresentation::DummySource
protected

Definition at line 142 of file vtkGlyph3DRepresentation.h.

◆ MeshVisibility

bool vtkGlyph3DRepresentation::MeshVisibility
protected

Definition at line 144 of file vtkGlyph3DRepresentation.h.


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