VTK  9.7.20260811
vtkSurfaceRepresentation Class Reference

#include <vtkSurfaceRepresentation.h>

Detailed Description

Renders any dataset as a surface with a flat property API.

vtkSurfaceRepresentation is a data representation that renders any dataset as a surface. Non-polygonal inputs are automatically converted via vtkGeometryFilterDispatcher, which handles a wide range of data types including vtkDataSet, vtkHyperTreeGrid, vtkCellGrid, vtkGenericDataSet, and composite datasets. All common display properties (color, opacity, representation mode, scalar coloring, scalar bar) are exposed through a flat API so that callers never need to reach into mapper, actor, or property objects directly.

Internal pipeline:
* Input (any dataset)
*   -> vtkGeometryFilterDispatcher (extract outer surface)
*     -> vtkCompositePolyDataMapper
*       -> vtkActor
* 
See also
vtkDataRepresentation vtkStandardRenderView vtkVolumeRepresentation vtkGeometryFilterDispatcher
Examples:
vtkSurfaceRepresentation (Examples)
Tests:
vtkSurfaceRepresentation (Tests)

Definition at line 52 of file vtkSurfaceRepresentation.h.

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

Public Types

enum  RepresentationType {
  POINTS = 0 , WIREFRAME = 1 , SURFACE = 2 , SURFACE_WITH_EDGES = 3 ,
  OUTLINE = 4 , FEATURE_EDGES = 5
}
 Representation type constants. More...
typedef vtkDataRepresentation Superclass
Public Types inherited from vtkDataRepresentation
typedef vtkPassInputTypeAlgorithm Superclass
Public Types inherited from vtkPassInputTypeAlgorithm
typedef vtkAlgorithm Superclass
Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject Superclass

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
vtkSurfaceRepresentationNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
vtkMTimeType GetMTime () override
 The representation stores its properties on the geometry filter, mapper, actor and scalar bar it owns rather than in its own ivars.
vtkActorGetSelectionActor ()
 Provide access to the internal selection actor for advanced usage.
vtkActorGetActor ()
 Provide access to the internal actor for advanced usage.
void SetRepresentation (int type)
 Set/get the representation mode.
int GetRepresentation ()
 Set/get the representation mode.
void SetRepresentationToPoints ()
 Set/get the representation mode.
void SetRepresentationToWireframe ()
 Set/get the representation mode.
void SetRepresentationToSurface ()
 Set/get the representation mode.
void SetRepresentationToSurfaceWithEdges ()
 Set/get the representation mode.
void SetRepresentationToOutline ()
 Set/get the representation mode.
void SetRepresentationToFeatureEdges ()
 Set/get the representation mode.
const char * GetRepresentationAsString ()
 Set/get the representation mode.
void SetColor (double r, double g, double b)
 Color and material properties (forwarded to vtkProperty).
double * GetColor ()
 Color and material properties (forwarded to vtkProperty).
void SetOpacity (double val)
 Color and material properties (forwarded to vtkProperty).
double GetOpacity ()
 Color and material properties (forwarded to vtkProperty).
void SetEdgeColor (double r, double g, double b)
 Color and material properties (forwarded to vtkProperty).
double * GetEdgeColor ()
 Color and material properties (forwarded to vtkProperty).
void SetEdgeOpacity (double val)
 Color and material properties (forwarded to vtkProperty).
double GetEdgeOpacity ()
 Color and material properties (forwarded to vtkProperty).
void SetAmbient (double val)
 Color and material properties (forwarded to vtkProperty).
double GetAmbient ()
 Color and material properties (forwarded to vtkProperty).
void SetDiffuse (double val)
 Color and material properties (forwarded to vtkProperty).
double GetDiffuse ()
 Color and material properties (forwarded to vtkProperty).
void SetSpecular (double val)
 Color and material properties (forwarded to vtkProperty).
double GetSpecular ()
 Color and material properties (forwarded to vtkProperty).
void SetSpecularPower (double val)
 Color and material properties (forwarded to vtkProperty).
double GetSpecularPower ()
 Color and material properties (forwarded to vtkProperty).
void SetLineWidth (double val)
 Color and material properties (forwarded to vtkProperty).
double GetLineWidth ()
 Color and material properties (forwarded to vtkProperty).
void SetPointSize (double val)
 Color and material properties (forwarded to vtkProperty).
double GetPointSize ()
 Color and material properties (forwarded to vtkProperty).
void SetLighting (bool val)
 Color and material properties (forwarded to vtkProperty).
bool GetLighting ()
 Color and material properties (forwarded to vtkProperty).
void SetInterpolation (int val)
 Color and material properties (forwarded to vtkProperty).
int GetInterpolation ()
 Color and material properties (forwarded to vtkProperty).
void SetRenderPointsAsSpheres (bool val)
 Color and material properties (forwarded to vtkProperty).
bool GetRenderPointsAsSpheres ()
 Color and material properties (forwarded to vtkProperty).
void SetRenderLinesAsTubes (bool val)
 Color and material properties (forwarded to vtkProperty).
bool GetRenderLinesAsTubes ()
 Color and material properties (forwarded to vtkProperty).
void SetRoughness (double val)
 Color and material properties (forwarded to vtkProperty).
double GetRoughness ()
 Color and material properties (forwarded to vtkProperty).
void SetMetallic (double val)
 Color and material properties (forwarded to vtkProperty).
double GetMetallic ()
 Color and material properties (forwarded to vtkProperty).
void SetScalarVisibility (bool val)
 Scalar coloring (forwarded to mapper).
bool GetScalarVisibility ()
 Scalar coloring (forwarded to mapper).
void ColorByPointArray (const char *arrayName)
 Scalar coloring (forwarded to mapper).
void ColorByPointArray (const char *arrayName, int component)
 Scalar coloring (forwarded to mapper).
void ColorByCellArray (const char *arrayName)
 Scalar coloring (forwarded to mapper).
void ColorByCellArray (const char *arrayName, int component)
 Scalar coloring (forwarded to mapper).
void ColorByFieldArray (const char *arrayName)
 Scalar coloring (forwarded to mapper).
void ColorByFieldArray (const char *arrayName, int component)
 Scalar coloring (forwarded to mapper).
void SetLookupTable (vtkScalarsToColors *lut)
 Scalar coloring (forwarded to mapper).
vtkScalarsToColorsGetLookupTable ()
 Scalar coloring (forwarded to mapper).
void SetInterpolateScalarsBeforeMapping (bool val)
 Scalar coloring (forwarded to mapper).
bool GetInterpolateScalarsBeforeMapping ()
 Scalar coloring (forwarded to mapper).
void SetFieldDataTupleId (vtkIdType id)
 Which tuple of the array selected by ColorByFieldArray() to color with.
vtkIdType GetFieldDataTupleId ()
 Which tuple of the array selected by ColorByFieldArray() to color with.
void SetGeneratePointNormals (bool val)
 Normal generation (forwarded to vtkGeometryFilterDispatcher).
bool GetGeneratePointNormals ()
 Normal generation (forwarded to vtkGeometryFilterDispatcher).
void SetGenerateCellNormals (bool val)
 Normal generation (forwarded to vtkGeometryFilterDispatcher).
bool GetGenerateCellNormals ()
 Normal generation (forwarded to vtkGeometryFilterDispatcher).
void SetFeatureAngle (double val)
 Normal generation (forwarded to vtkGeometryFilterDispatcher).
double GetFeatureAngle ()
 Normal generation (forwarded to vtkGeometryFilterDispatcher).
void SetSplitting (bool val)
 Normal generation (forwarded to vtkGeometryFilterDispatcher).
bool GetSplitting ()
 Normal generation (forwarded to vtkGeometryFilterDispatcher).
void SetTriangulate (bool val)
 Mesh processing options (forwarded to vtkGeometryFilterDispatcher).
bool GetTriangulate ()
 Mesh processing options (forwarded to vtkGeometryFilterDispatcher).
void SetNonlinearSubdivisionLevel (int val)
 Mesh processing options (forwarded to vtkGeometryFilterDispatcher).
int GetNonlinearSubdivisionLevel ()
 Mesh processing options (forwarded to vtkGeometryFilterDispatcher).
void SetMatchBoundariesIgnoringCellOrder (bool val)
 Mesh processing options (forwarded to vtkGeometryFilterDispatcher).
bool GetMatchBoundariesIgnoringCellOrder ()
 Mesh processing options (forwarded to vtkGeometryFilterDispatcher).
void SetPassThroughCellIds (bool val)
 Picking support (forwarded to vtkGeometryFilterDispatcher).
bool GetPassThroughCellIds ()
 Picking support (forwarded to vtkGeometryFilterDispatcher).
void SetPassThroughPointIds (bool val)
 Picking support (forwarded to vtkGeometryFilterDispatcher).
bool GetPassThroughPointIds ()
 Picking support (forwarded to vtkGeometryFilterDispatcher).
void SetBlockColorsDistinctValues (int val)
 Composite and AMR options (forwarded to vtkGeometryFilterDispatcher).
int GetBlockColorsDistinctValues ()
 Composite and AMR options (forwarded to vtkGeometryFilterDispatcher).
void SetHideInternalAMRFaces (bool val)
 Composite and AMR options (forwarded to vtkGeometryFilterDispatcher).
bool GetHideInternalAMRFaces ()
 Composite and AMR options (forwarded to vtkGeometryFilterDispatcher).
void SetUseNonOverlappingAMRMetaDataForOutlines (bool val)
 Composite and AMR options (forwarded to vtkGeometryFilterDispatcher).
bool GetUseNonOverlappingAMRMetaDataForOutlines ()
 Composite and AMR options (forwarded to vtkGeometryFilterDispatcher).
void SetGenerateProcessIds (bool val)
 Parallel option (forwarded to vtkGeometryFilterDispatcher).
bool GetGenerateProcessIds ()
 Parallel option (forwarded to vtkGeometryFilterDispatcher).
void SetVisibility (bool val)
 Visibility, pickability, and actor transforms.
bool GetVisibility ()
 Visibility, pickability, and actor transforms.
void SetPickable (bool val)
 Visibility, pickability, and actor transforms.
bool GetPickable ()
 Visibility, pickability, and actor transforms.
void SetPosition (double x, double y, double z)
 Visibility, pickability, and actor transforms.
double * GetPosition ()
 Visibility, pickability, and actor transforms.
void SetOrientation (double x, double y, double z)
 Visibility, pickability, and actor transforms.
double * GetOrientation ()
 Visibility, pickability, and actor transforms.
void SetScale (double x, double y, double z)
 Visibility, pickability, and actor transforms.
double * GetScale ()
 Visibility, pickability, and actor transforms.
void SetScalarBarVisibility (bool val)
 Scalar bar control.
bool GetScalarBarVisibility ()
 Scalar bar control.
vtkScalarBarActorGetScalarBarActor ()
 Scalar bar control.
void SetSelectionColor (double r, double g, double b)
 Selection display properties.
double * GetSelectionColor ()
 Selection display properties.
void SetSelectionOpacity (double val)
 Selection display properties.
double GetSelectionOpacity ()
 Selection display properties.
void SetSelectionLineWidth (double val)
 Selection display properties.
double GetSelectionLineWidth ()
 Selection display properties.
void SetSelectionPointSize (double val)
 Selection display properties.
double GetSelectionPointSize ()
 Selection display properties.
void SetSelectionRepresentation (int type)
 The selection is drawn from the same geometry as the representation itself, so only the property-level RepresentationType values (POINTS, WIREFRAME, SURFACE, SURFACE_WITH_EDGES) apply here.
int GetSelectionRepresentation ()
 Selection display properties.
Public Member Functions inherited from vtkDataRepresentation
vtkDataRepresentationNewInstance () const
vtkAlgorithmOutputGetInputConnection (int port=0, int index=0)
 Convenience override method for obtaining the input connection without specifying the port or index.
vtkAnnotationLinkGetAnnotationLink ()
 The annotation link for this representation.
void SetAnnotationLink (vtkAnnotationLink *link)
virtual void ApplyViewTheme (vtkViewTheme *theme)
 Apply a theme to this representation.
void Select (vtkView *view, vtkSelection *selection)
 The view calls this method when a selection occurs.
void Select (vtkView *view, vtkSelection *selection, bool extend)
void Annotate (vtkView *view, vtkAnnotationLayers *annotations)
 Analogous to Select().
void Annotate (vtkView *view, vtkAnnotationLayers *annotations, bool extend)
void UpdateSelection (vtkSelection *selection)
 Updates the selection in the selection link and fires a selection change event.
void UpdateSelection (vtkSelection *selection, bool extend)
void UpdateAnnotations (vtkAnnotationLayers *annotations)
 Updates the selection in the selection link and fires a selection change event.
void UpdateAnnotations (vtkAnnotationLayers *annotations, bool extend)
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort ()
 The output port that contains the annotations whose selections are localized for a particular input data object.
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort (int port)
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort (int port, int conn)
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort ()
 The output port that contains the selection associated with the current annotation (normally the interactive selection).
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort (int port)
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort (int port, int conn)
virtual vtkAlgorithmOutputGetInternalOutputPort ()
 Retrieves an output port for the input data object at the specified port and connection index.
virtual vtkAlgorithmOutputGetInternalOutputPort (int port)
virtual vtkAlgorithmOutputGetInternalOutputPort (int port, int conn)
virtual void SetSelectable (bool)
 Whether this representation is able to handle a selection.
virtual bool GetSelectable ()
 Whether this representation is able to handle a selection.
virtual void SelectableOn ()
 Whether this representation is able to handle a selection.
virtual void SelectableOff ()
 Whether this representation is able to handle a selection.
virtual void SetSelectionType (int)
 Set the selection type produced by this view.
virtual int GetSelectionType ()
 Set the selection type produced by this view.
virtual void SetSelectionArrayNames (vtkStringArray *names)
 If a VALUES selection, the arrays used to produce a selection.
virtual vtkStringArrayGetSelectionArrayNames ()
 If a VALUES selection, the arrays used to produce a selection.
virtual void SetSelectionArrayName (const char *name)
 If a VALUES selection, the array used to produce a selection.
virtual const char * GetSelectionArrayName ()
 If a VALUES selection, the array used to produce a selection.
Public Member Functions inherited from vtkPassInputTypeAlgorithm
vtkPassInputTypeAlgorithmNewInstance () const
vtkDataObjectGetInput ()
 Get the input data object.
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details
vtkDataObjectGetOutput ()
 Get the output data object for a port on this algorithm.
vtkDataObjectGetOutput (int)
 Get the output data object for a port on this algorithm.
vtkPolyDataGetPolyDataOutput ()
 Get the output as a concrete type.
vtkStructuredPointsGetStructuredPointsOutput ()
 Get the output as a concrete type.
vtkImageDataGetImageDataOutput ()
 Get the output as a concrete type.
vtkStructuredGridGetStructuredGridOutput ()
 Get the output as a concrete type.
vtkUnstructuredGridGetUnstructuredGridOutput ()
 Get the output as a concrete type.
vtkRectilinearGridGetRectilinearGridOutput ()
 Get the output as a concrete type.
vtkGraphGetGraphOutput ()
 Get the output as a concrete type.
vtkMoleculeGetMoleculeOutput ()
 Get the output as a concrete type.
vtkTableGetTableOutput ()
 Get the output as a concrete type.
vtkHyperTreeGridGetHyperTreeGridOutput ()
 Get the output as a concrete type.
void SetInputData (vtkDataObject *)
 Assign a data object as input.
void SetInputData (int, vtkDataObject *)
 Assign a data object as input.
void AddInputData (vtkDataObject *)
 Assign a data object as input.
void AddInputData (int, vtkDataObject *)
 Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive.
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request.
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port.
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime.
void UpdateProgress (double amount)
 Update the progress of the process object.
bool CheckAbort ()
 Checks to see if this filter should abort.
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
int GetNumberOfInputArraySpecifications ()
 Get the number of input array indices that have already been set.
bool ResetInputArraySpecifications ()
 Clear all existing input array specifications (as if SetInputArrayToProcess had never been called).
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
void RemoveAllInputs ()
 Remove all the input data.
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
virtual void SetInputDataObject (vtkDataObject *data)
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
virtual void AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutputGetOutputPort ()
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0).
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0).
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
virtual bool UpdateInformation ()
 Bring the algorithm's information up-to-date.
virtual bool UpdateDataObject ()
 Create output object(s).
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
virtual bool UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
bool UsesGarbageCollector () const override
 Participate in garbage collection.
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
virtual double GetProgress ()
 Get the execution progress of a process object.
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm.
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm.
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive.
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
virtual void AbortOutputOn ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
virtual void AbortOutputOff ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
void SetInputArrayToProcess (const char *name, int fieldAssociation, int component=vtkArrayComponents::AllComponents)
 Set the input data arrays that this algorithm will process.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name, int component)
 This method variant also accepts a component to consider rather than the entire tuple.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType, int component)
 This method variant also accepts a component to consider rather than the entire tuple.
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 Set the input data arrays that this algorithm will process.
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName, const char *component)
 Set the input data arrays that this algorithm will process.
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
virtual bool Update (int port)
 Bring this algorithm's outputs up-to-date.
virtual bool Update ()
 Bring this algorithm's outputs up-to-date.
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports.
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void DebugOn ()
 Turn debugging output on.
virtual void DebugOff ()
 Turn debugging output off.
bool GetDebug ()
 Get the value of the debug flag.
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
virtual void Modified ()
 Update the modification time for this object.
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
vtkTypeBool HasObserver (unsigned long event)
vtkTypeBool HasObserver (const char *event)
vtkTypeBool InvokeEvent (unsigned long event)
vtkTypeBool InvokeEvent (const char *event)
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void Delete ()
 Delete a VTK object.
virtual void FastDelete ()
 Delete a reference to this object.
void InitializeObjectBase ()
void Print (ostream &os)
 Print an object to an ostream.
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int)
 Sets the reference count.
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions

static vtkSurfaceRepresentationNew ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkSurfaceRepresentationSafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkDataRepresentation
static vtkDataRepresentationNew ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkDataRepresentationSafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPassInputTypeAlgorithm
static vtkPassInputTypeAlgorithmNew ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkPassInputTypeAlgorithmSafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKeyINPUT_PORT ()
static vtkInformationIntegerKeyINPUT_CONNECTION ()
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKeyABORTED ()
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkSurfaceRepresentation ()
 ~vtkSurfaceRepresentation () override
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Subclasses should override this to connect inputs to the internal pipeline as necessary.
bool AddToView (vtkView *view) override
 Adds the representation to the view.
bool RemoveFromView (vtkView *view) override
 Removes the representation to the view.
vtkSelectionConvertSelection (vtkView *view, vtkSelection *selection) override
 Convert the selection to a type appropriate for sharing with other representations through vtkAnnotationLink, possibly using the view.
Protected Member Functions inherited from vtkDataRepresentation
 vtkDataRepresentation ()
 ~vtkDataRepresentation () override
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
 Clear the input shallow copy caches if the algorithm is in "release data" mode.
virtual vtkAnnotationLayersConvertAnnotations (vtkView *view, vtkAnnotationLayers *annotations)
 Analogous to ConvertSelection(), allows subclasses to manipulate annotations before passing them off to vtkAnnotationLink.
vtkTrivialProducerGetInternalInput (int port, int conn)
void SetInternalInput (int port, int conn, vtkTrivialProducer *producer)
virtual void SetAnnotationLinkInternal (vtkAnnotationLink *link)
 The annotation link for this representation.
Protected Member Functions inherited from vtkPassInputTypeAlgorithm
 vtkPassInputTypeAlgorithm ()
 ~vtkPassInputTypeAlgorithm () override=default
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called within ProcessRequest when a request asks the algorithm to create empty output data objects.
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request asks for Information.
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request ask for temporal information to be updated.
virtual int RequestUpdateTimeDependentInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request ask for meta information to be updated.
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for.
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm.
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
vtkDataObjectGetInput (int port)
Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm () override
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted.
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm.
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm.
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
int GetInputArrayComponent (int idx)
 Get the component to process of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive.
void ReportReferences (vtkGarbageCollector *) override
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
void AddInputDataInternal (int port, vtkDataObject *input)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
vtkSmartPointer< vtkAbstractArrayGetInputArray (int idx, int connection, vtkInformationVector **inputVector, int &association, int requestedComponent=vtkArrayComponents::Requested)
 Get an array from the input at index idx.
vtkSmartPointer< vtkAbstractArrayGetInputArray (int idx, vtkDataObject *input, int &association, int requestedComponent=vtkArrayComponents::Requested)
 Get an array from the input at index idx.
template<typename ArrayType, typename... Params>
vtkSmartPointer< ArrayType > GetInputArrayAs (Params &&... params)
 Get an array from the input at index idx.
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file.
Protected Member Functions inherited from vtkObject
 vtkObject ()
 ~vtkObject () override
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
static vtkReallocingFunction GetCurrentReallocFunction ()
static vtkFreeingFunction GetCurrentFreeFunction ()
static vtkFreeingFunction GetAlternateFreeFunction ()
Protected Attributes inherited from vtkDataRepresentation
bool Selectable
int SelectionType
 The selection type created by the view.
vtkStringArraySelectionArrayNames
 If a VALUES selection, the array names used in the selection.
CommandObserver
vtkAnnotationLinkAnnotationLinkInternal
 The annotation link for this representation.
Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
vtkInformationInformation
double Progress
char * ProgressText
vtkProgressObserverProgressObserver
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
Protected Attributes inherited from vtkObject
bool Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
std::string ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
vtkWeakPointerBase ** WeakPointers
Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
static vtkExecutiveDefaultExecutivePrototype

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ RepresentationType

Representation type constants.

POINTS, WIREFRAME, SURFACE and SURFACE_WITH_EDGES draw the extracted surface and differ only in how the actor's property renders it. OUTLINE and FEATURE_EDGES change what geometry is extracted in the first place: OUTLINE produces the bounding box of the input and FEATURE_EDGES produces the edges whose adjacent faces meet at more than the feature angle.

Enumerator
POINTS 
WIREFRAME 
SURFACE 
SURFACE_WITH_EDGES 
OUTLINE 
FEATURE_EDGES 

Definition at line 77 of file vtkSurfaceRepresentation.h.

Constructor & Destructor Documentation

◆ vtkSurfaceRepresentation()

vtkSurfaceRepresentation::vtkSurfaceRepresentation ( )
protected

◆ ~vtkSurfaceRepresentation()

vtkSurfaceRepresentation::~vtkSurfaceRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

vtkSurfaceRepresentation * vtkSurfaceRepresentation::New ( )
static

◆ IsTypeOf()

vtkTypeBool vtkSurfaceRepresentation::IsTypeOf ( const char * type)
static

◆ IsA()

virtual vtkTypeBool vtkSurfaceRepresentation::IsA ( const char * name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataRepresentation.

◆ SafeDownCast()

vtkSurfaceRepresentation * vtkSurfaceRepresentation::SafeDownCast ( vtkObjectBase * o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSurfaceRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataRepresentation.

◆ NewInstance()

vtkSurfaceRepresentation * vtkSurfaceRepresentation::NewInstance ( ) const

◆ PrintSelf()

void vtkSurfaceRepresentation::PrintSelf ( ostream & os,
vtkIndent indent )
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataRepresentation.

◆ GetMTime()

vtkMTimeType vtkSurfaceRepresentation::GetMTime ( )
overridevirtual

The representation stores its properties on the geometry filter, mapper, actor and scalar bar it owns rather than in its own ivars.

Those objects are also reachable through GetActor(), GetScalarBarActor() and friends, so the modified time reported here is the latest of this object's own and theirs.

Reimplemented from vtkObject.

◆ SetRepresentation()

void vtkSurfaceRepresentation::SetRepresentation ( int type)

Set/get the representation mode.

Use the RepresentationType enum or the SetRepresentationTo* convenience methods. The Python wrapping also accepts the matching string names (case-insensitive), e.g. "Wireframe" or "SurfaceWithEdges".

The modes are mutually exclusive: there is no way to ask for an outline and feature edges at the same time. The default is SURFACE.

◆ GetRepresentation()

int vtkSurfaceRepresentation::GetRepresentation ( )

Set/get the representation mode.

Use the RepresentationType enum or the SetRepresentationTo* convenience methods. The Python wrapping also accepts the matching string names (case-insensitive), e.g. "Wireframe" or "SurfaceWithEdges".

The modes are mutually exclusive: there is no way to ask for an outline and feature edges at the same time. The default is SURFACE.

◆ SetRepresentationToPoints()

void vtkSurfaceRepresentation::SetRepresentationToPoints ( )
inline

Set/get the representation mode.

Use the RepresentationType enum or the SetRepresentationTo* convenience methods. The Python wrapping also accepts the matching string names (case-insensitive), e.g. "Wireframe" or "SurfaceWithEdges".

The modes are mutually exclusive: there is no way to ask for an outline and feature edges at the same time. The default is SURFACE.

Definition at line 99 of file vtkSurfaceRepresentation.h.

◆ SetRepresentationToWireframe()

void vtkSurfaceRepresentation::SetRepresentationToWireframe ( )
inline

Set/get the representation mode.

Use the RepresentationType enum or the SetRepresentationTo* convenience methods. The Python wrapping also accepts the matching string names (case-insensitive), e.g. "Wireframe" or "SurfaceWithEdges".

The modes are mutually exclusive: there is no way to ask for an outline and feature edges at the same time. The default is SURFACE.

Definition at line 100 of file vtkSurfaceRepresentation.h.

◆ SetRepresentationToSurface()

void vtkSurfaceRepresentation::SetRepresentationToSurface ( )
inline

Set/get the representation mode.

Use the RepresentationType enum or the SetRepresentationTo* convenience methods. The Python wrapping also accepts the matching string names (case-insensitive), e.g. "Wireframe" or "SurfaceWithEdges".

The modes are mutually exclusive: there is no way to ask for an outline and feature edges at the same time. The default is SURFACE.

Definition at line 101 of file vtkSurfaceRepresentation.h.

◆ SetRepresentationToSurfaceWithEdges()

void vtkSurfaceRepresentation::SetRepresentationToSurfaceWithEdges ( )
inline

Set/get the representation mode.

Use the RepresentationType enum or the SetRepresentationTo* convenience methods. The Python wrapping also accepts the matching string names (case-insensitive), e.g. "Wireframe" or "SurfaceWithEdges".

The modes are mutually exclusive: there is no way to ask for an outline and feature edges at the same time. The default is SURFACE.

Definition at line 102 of file vtkSurfaceRepresentation.h.

◆ SetRepresentationToOutline()

void vtkSurfaceRepresentation::SetRepresentationToOutline ( )
inline

Set/get the representation mode.

Use the RepresentationType enum or the SetRepresentationTo* convenience methods. The Python wrapping also accepts the matching string names (case-insensitive), e.g. "Wireframe" or "SurfaceWithEdges".

The modes are mutually exclusive: there is no way to ask for an outline and feature edges at the same time. The default is SURFACE.

Definition at line 103 of file vtkSurfaceRepresentation.h.

◆ SetRepresentationToFeatureEdges()

void vtkSurfaceRepresentation::SetRepresentationToFeatureEdges ( )
inline

Set/get the representation mode.

Use the RepresentationType enum or the SetRepresentationTo* convenience methods. The Python wrapping also accepts the matching string names (case-insensitive), e.g. "Wireframe" or "SurfaceWithEdges".

The modes are mutually exclusive: there is no way to ask for an outline and feature edges at the same time. The default is SURFACE.

Definition at line 104 of file vtkSurfaceRepresentation.h.

◆ GetRepresentationAsString()

const char * vtkSurfaceRepresentation::GetRepresentationAsString ( )

Set/get the representation mode.

Use the RepresentationType enum or the SetRepresentationTo* convenience methods. The Python wrapping also accepts the matching string names (case-insensitive), e.g. "Wireframe" or "SurfaceWithEdges".

The modes are mutually exclusive: there is no way to ask for an outline and feature edges at the same time. The default is SURFACE.

◆ SetColor()

void vtkSurfaceRepresentation::SetColor ( double r,
double g,
double b )

Color and material properties (forwarded to vtkProperty).

◆ GetColor()

double * vtkSurfaceRepresentation::GetColor ( )

Color and material properties (forwarded to vtkProperty).

◆ SetOpacity()

void vtkSurfaceRepresentation::SetOpacity ( double val)

Color and material properties (forwarded to vtkProperty).

◆ GetOpacity()

double vtkSurfaceRepresentation::GetOpacity ( )

Color and material properties (forwarded to vtkProperty).

◆ SetEdgeColor()

void vtkSurfaceRepresentation::SetEdgeColor ( double r,
double g,
double b )

Color and material properties (forwarded to vtkProperty).

◆ GetEdgeColor()

double * vtkSurfaceRepresentation::GetEdgeColor ( )

Color and material properties (forwarded to vtkProperty).

◆ SetEdgeOpacity()

void vtkSurfaceRepresentation::SetEdgeOpacity ( double val)

Color and material properties (forwarded to vtkProperty).

◆ GetEdgeOpacity()

double vtkSurfaceRepresentation::GetEdgeOpacity ( )

Color and material properties (forwarded to vtkProperty).

◆ SetAmbient()

void vtkSurfaceRepresentation::SetAmbient ( double val)

Color and material properties (forwarded to vtkProperty).

◆ GetAmbient()

double vtkSurfaceRepresentation::GetAmbient ( )

Color and material properties (forwarded to vtkProperty).

◆ SetDiffuse()

void vtkSurfaceRepresentation::SetDiffuse ( double val)

Color and material properties (forwarded to vtkProperty).

◆ GetDiffuse()

double vtkSurfaceRepresentation::GetDiffuse ( )

Color and material properties (forwarded to vtkProperty).

◆ SetSpecular()

void vtkSurfaceRepresentation::SetSpecular ( double val)

Color and material properties (forwarded to vtkProperty).

◆ GetSpecular()

double vtkSurfaceRepresentation::GetSpecular ( )

Color and material properties (forwarded to vtkProperty).

◆ SetSpecularPower()

void vtkSurfaceRepresentation::SetSpecularPower ( double val)

Color and material properties (forwarded to vtkProperty).

◆ GetSpecularPower()

double vtkSurfaceRepresentation::GetSpecularPower ( )

Color and material properties (forwarded to vtkProperty).

◆ SetLineWidth()

void vtkSurfaceRepresentation::SetLineWidth ( double val)

Color and material properties (forwarded to vtkProperty).

◆ GetLineWidth()

double vtkSurfaceRepresentation::GetLineWidth ( )

Color and material properties (forwarded to vtkProperty).

◆ SetPointSize()

void vtkSurfaceRepresentation::SetPointSize ( double val)

Color and material properties (forwarded to vtkProperty).

◆ GetPointSize()

double vtkSurfaceRepresentation::GetPointSize ( )

Color and material properties (forwarded to vtkProperty).

◆ SetLighting()

void vtkSurfaceRepresentation::SetLighting ( bool val)

Color and material properties (forwarded to vtkProperty).

◆ GetLighting()

bool vtkSurfaceRepresentation::GetLighting ( )

Color and material properties (forwarded to vtkProperty).

◆ SetInterpolation()

void vtkSurfaceRepresentation::SetInterpolation ( int val)

Color and material properties (forwarded to vtkProperty).

◆ GetInterpolation()

int vtkSurfaceRepresentation::GetInterpolation ( )

Color and material properties (forwarded to vtkProperty).

◆ SetRenderPointsAsSpheres()

void vtkSurfaceRepresentation::SetRenderPointsAsSpheres ( bool val)

Color and material properties (forwarded to vtkProperty).

◆ GetRenderPointsAsSpheres()

bool vtkSurfaceRepresentation::GetRenderPointsAsSpheres ( )

Color and material properties (forwarded to vtkProperty).

◆ SetRenderLinesAsTubes()

void vtkSurfaceRepresentation::SetRenderLinesAsTubes ( bool val)

Color and material properties (forwarded to vtkProperty).

◆ GetRenderLinesAsTubes()

bool vtkSurfaceRepresentation::GetRenderLinesAsTubes ( )

Color and material properties (forwarded to vtkProperty).

◆ SetRoughness()

void vtkSurfaceRepresentation::SetRoughness ( double val)

Color and material properties (forwarded to vtkProperty).

◆ GetRoughness()

double vtkSurfaceRepresentation::GetRoughness ( )

Color and material properties (forwarded to vtkProperty).

◆ SetMetallic()

void vtkSurfaceRepresentation::SetMetallic ( double val)

Color and material properties (forwarded to vtkProperty).

◆ GetMetallic()

double vtkSurfaceRepresentation::GetMetallic ( )

Color and material properties (forwarded to vtkProperty).

◆ SetScalarVisibility()

void vtkSurfaceRepresentation::SetScalarVisibility ( bool val)

Scalar coloring (forwarded to mapper).

ColorByPointArray and ColorByCellArray color by an array attached to the points or the cells. ColorByFieldArray colors by an array in the field data, which carries no per-element association of its own: by default its tuples are consumed one per cell, and SetFieldDataTupleId() switches to coloring the whole surface with a single tuple.

The overloads taking a component select which component of a multi-component array to map; the others map the array as the lookup table sees fit, which for vectors is the magnitude.

The range that scalars are mapped through belongs to the lookup table, not to the representation: set it with GetLookupTable()->SetRange(), or on a table of your own before handing it over. A table shared between representations therefore keeps one range, and the representation never writes over the range you gave it.

◆ GetScalarVisibility()

bool vtkSurfaceRepresentation::GetScalarVisibility ( )

Scalar coloring (forwarded to mapper).

ColorByPointArray and ColorByCellArray color by an array attached to the points or the cells. ColorByFieldArray colors by an array in the field data, which carries no per-element association of its own: by default its tuples are consumed one per cell, and SetFieldDataTupleId() switches to coloring the whole surface with a single tuple.

The overloads taking a component select which component of a multi-component array to map; the others map the array as the lookup table sees fit, which for vectors is the magnitude.

The range that scalars are mapped through belongs to the lookup table, not to the representation: set it with GetLookupTable()->SetRange(), or on a table of your own before handing it over. A table shared between representations therefore keeps one range, and the representation never writes over the range you gave it.

◆ ColorByPointArray() [1/2]

void vtkSurfaceRepresentation::ColorByPointArray ( const char * arrayName)

Scalar coloring (forwarded to mapper).

ColorByPointArray and ColorByCellArray color by an array attached to the points or the cells. ColorByFieldArray colors by an array in the field data, which carries no per-element association of its own: by default its tuples are consumed one per cell, and SetFieldDataTupleId() switches to coloring the whole surface with a single tuple.

The overloads taking a component select which component of a multi-component array to map; the others map the array as the lookup table sees fit, which for vectors is the magnitude.

The range that scalars are mapped through belongs to the lookup table, not to the representation: set it with GetLookupTable()->SetRange(), or on a table of your own before handing it over. A table shared between representations therefore keeps one range, and the representation never writes over the range you gave it.

◆ ColorByPointArray() [2/2]

void vtkSurfaceRepresentation::ColorByPointArray ( const char * arrayName,
int component )

Scalar coloring (forwarded to mapper).

ColorByPointArray and ColorByCellArray color by an array attached to the points or the cells. ColorByFieldArray colors by an array in the field data, which carries no per-element association of its own: by default its tuples are consumed one per cell, and SetFieldDataTupleId() switches to coloring the whole surface with a single tuple.

The overloads taking a component select which component of a multi-component array to map; the others map the array as the lookup table sees fit, which for vectors is the magnitude.

The range that scalars are mapped through belongs to the lookup table, not to the representation: set it with GetLookupTable()->SetRange(), or on a table of your own before handing it over. A table shared between representations therefore keeps one range, and the representation never writes over the range you gave it.

◆ ColorByCellArray() [1/2]

void vtkSurfaceRepresentation::ColorByCellArray ( const char * arrayName)

Scalar coloring (forwarded to mapper).

ColorByPointArray and ColorByCellArray color by an array attached to the points or the cells. ColorByFieldArray colors by an array in the field data, which carries no per-element association of its own: by default its tuples are consumed one per cell, and SetFieldDataTupleId() switches to coloring the whole surface with a single tuple.

The overloads taking a component select which component of a multi-component array to map; the others map the array as the lookup table sees fit, which for vectors is the magnitude.

The range that scalars are mapped through belongs to the lookup table, not to the representation: set it with GetLookupTable()->SetRange(), or on a table of your own before handing it over. A table shared between representations therefore keeps one range, and the representation never writes over the range you gave it.

◆ ColorByCellArray() [2/2]

void vtkSurfaceRepresentation::ColorByCellArray ( const char * arrayName,
int component )

Scalar coloring (forwarded to mapper).

ColorByPointArray and ColorByCellArray color by an array attached to the points or the cells. ColorByFieldArray colors by an array in the field data, which carries no per-element association of its own: by default its tuples are consumed one per cell, and SetFieldDataTupleId() switches to coloring the whole surface with a single tuple.

The overloads taking a component select which component of a multi-component array to map; the others map the array as the lookup table sees fit, which for vectors is the magnitude.

The range that scalars are mapped through belongs to the lookup table, not to the representation: set it with GetLookupTable()->SetRange(), or on a table of your own before handing it over. A table shared between representations therefore keeps one range, and the representation never writes over the range you gave it.

◆ ColorByFieldArray() [1/2]

void vtkSurfaceRepresentation::ColorByFieldArray ( const char * arrayName)

Scalar coloring (forwarded to mapper).

ColorByPointArray and ColorByCellArray color by an array attached to the points or the cells. ColorByFieldArray colors by an array in the field data, which carries no per-element association of its own: by default its tuples are consumed one per cell, and SetFieldDataTupleId() switches to coloring the whole surface with a single tuple.

The overloads taking a component select which component of a multi-component array to map; the others map the array as the lookup table sees fit, which for vectors is the magnitude.

The range that scalars are mapped through belongs to the lookup table, not to the representation: set it with GetLookupTable()->SetRange(), or on a table of your own before handing it over. A table shared between representations therefore keeps one range, and the representation never writes over the range you gave it.

◆ ColorByFieldArray() [2/2]

void vtkSurfaceRepresentation::ColorByFieldArray ( const char * arrayName,
int component )

Scalar coloring (forwarded to mapper).

ColorByPointArray and ColorByCellArray color by an array attached to the points or the cells. ColorByFieldArray colors by an array in the field data, which carries no per-element association of its own: by default its tuples are consumed one per cell, and SetFieldDataTupleId() switches to coloring the whole surface with a single tuple.

The overloads taking a component select which component of a multi-component array to map; the others map the array as the lookup table sees fit, which for vectors is the magnitude.

The range that scalars are mapped through belongs to the lookup table, not to the representation: set it with GetLookupTable()->SetRange(), or on a table of your own before handing it over. A table shared between representations therefore keeps one range, and the representation never writes over the range you gave it.

◆ SetLookupTable()

void vtkSurfaceRepresentation::SetLookupTable ( vtkScalarsToColors * lut)

Scalar coloring (forwarded to mapper).

ColorByPointArray and ColorByCellArray color by an array attached to the points or the cells. ColorByFieldArray colors by an array in the field data, which carries no per-element association of its own: by default its tuples are consumed one per cell, and SetFieldDataTupleId() switches to coloring the whole surface with a single tuple.

The overloads taking a component select which component of a multi-component array to map; the others map the array as the lookup table sees fit, which for vectors is the magnitude.

The range that scalars are mapped through belongs to the lookup table, not to the representation: set it with GetLookupTable()->SetRange(), or on a table of your own before handing it over. A table shared between representations therefore keeps one range, and the representation never writes over the range you gave it.

◆ GetLookupTable()

vtkScalarsToColors * vtkSurfaceRepresentation::GetLookupTable ( )

Scalar coloring (forwarded to mapper).

ColorByPointArray and ColorByCellArray color by an array attached to the points or the cells. ColorByFieldArray colors by an array in the field data, which carries no per-element association of its own: by default its tuples are consumed one per cell, and SetFieldDataTupleId() switches to coloring the whole surface with a single tuple.

The overloads taking a component select which component of a multi-component array to map; the others map the array as the lookup table sees fit, which for vectors is the magnitude.

The range that scalars are mapped through belongs to the lookup table, not to the representation: set it with GetLookupTable()->SetRange(), or on a table of your own before handing it over. A table shared between representations therefore keeps one range, and the representation never writes over the range you gave it.

◆ SetInterpolateScalarsBeforeMapping()

void vtkSurfaceRepresentation::SetInterpolateScalarsBeforeMapping ( bool val)

Scalar coloring (forwarded to mapper).

ColorByPointArray and ColorByCellArray color by an array attached to the points or the cells. ColorByFieldArray colors by an array in the field data, which carries no per-element association of its own: by default its tuples are consumed one per cell, and SetFieldDataTupleId() switches to coloring the whole surface with a single tuple.

The overloads taking a component select which component of a multi-component array to map; the others map the array as the lookup table sees fit, which for vectors is the magnitude.

The range that scalars are mapped through belongs to the lookup table, not to the representation: set it with GetLookupTable()->SetRange(), or on a table of your own before handing it over. A table shared between representations therefore keeps one range, and the representation never writes over the range you gave it.

◆ GetInterpolateScalarsBeforeMapping()

bool vtkSurfaceRepresentation::GetInterpolateScalarsBeforeMapping ( )

Scalar coloring (forwarded to mapper).

ColorByPointArray and ColorByCellArray color by an array attached to the points or the cells. ColorByFieldArray colors by an array in the field data, which carries no per-element association of its own: by default its tuples are consumed one per cell, and SetFieldDataTupleId() switches to coloring the whole surface with a single tuple.

The overloads taking a component select which component of a multi-component array to map; the others map the array as the lookup table sees fit, which for vectors is the magnitude.

The range that scalars are mapped through belongs to the lookup table, not to the representation: set it with GetLookupTable()->SetRange(), or on a table of your own before handing it over. A table shared between representations therefore keeps one range, and the representation never writes over the range you gave it.

◆ SetFieldDataTupleId()

void vtkSurfaceRepresentation::SetFieldDataTupleId ( vtkIdType id)

Which tuple of the array selected by ColorByFieldArray() to color with.

The default, -1, consumes the array one tuple per cell. An index of 0 or more colors the entire surface with the tuple at that index, which is how a per-block or per-dataset value is drawn. Has no effect when coloring by a point or cell array.

◆ GetFieldDataTupleId()

vtkIdType vtkSurfaceRepresentation::GetFieldDataTupleId ( )

Which tuple of the array selected by ColorByFieldArray() to color with.

The default, -1, consumes the array one tuple per cell. An index of 0 or more colors the entire surface with the tuple at that index, which is how a per-block or per-dataset value is drawn. Has no effect when coloring by a point or cell array.

◆ SetGeneratePointNormals()

void vtkSurfaceRepresentation::SetGeneratePointNormals ( bool val)

Normal generation (forwarded to vtkGeometryFilterDispatcher).

GeneratePointNormals enables smooth-shading normals (default off). GenerateCellNormals enables flat-shading normals (default off). FeatureAngle is the angle (degrees) that defines a sharp edge for normal splitting, and the angle used to select the edges extracted by the FEATURE_EDGES representation (default 30). Splitting controls whether sharp edges cause point duplication so that normals are discontinuous across them (default on).

◆ GetGeneratePointNormals()

bool vtkSurfaceRepresentation::GetGeneratePointNormals ( )

Normal generation (forwarded to vtkGeometryFilterDispatcher).

GeneratePointNormals enables smooth-shading normals (default off). GenerateCellNormals enables flat-shading normals (default off). FeatureAngle is the angle (degrees) that defines a sharp edge for normal splitting, and the angle used to select the edges extracted by the FEATURE_EDGES representation (default 30). Splitting controls whether sharp edges cause point duplication so that normals are discontinuous across them (default on).

◆ SetGenerateCellNormals()

void vtkSurfaceRepresentation::SetGenerateCellNormals ( bool val)

Normal generation (forwarded to vtkGeometryFilterDispatcher).

GeneratePointNormals enables smooth-shading normals (default off). GenerateCellNormals enables flat-shading normals (default off). FeatureAngle is the angle (degrees) that defines a sharp edge for normal splitting, and the angle used to select the edges extracted by the FEATURE_EDGES representation (default 30). Splitting controls whether sharp edges cause point duplication so that normals are discontinuous across them (default on).

◆ GetGenerateCellNormals()

bool vtkSurfaceRepresentation::GetGenerateCellNormals ( )

Normal generation (forwarded to vtkGeometryFilterDispatcher).

GeneratePointNormals enables smooth-shading normals (default off). GenerateCellNormals enables flat-shading normals (default off). FeatureAngle is the angle (degrees) that defines a sharp edge for normal splitting, and the angle used to select the edges extracted by the FEATURE_EDGES representation (default 30). Splitting controls whether sharp edges cause point duplication so that normals are discontinuous across them (default on).

◆ SetFeatureAngle()

void vtkSurfaceRepresentation::SetFeatureAngle ( double val)

Normal generation (forwarded to vtkGeometryFilterDispatcher).

GeneratePointNormals enables smooth-shading normals (default off). GenerateCellNormals enables flat-shading normals (default off). FeatureAngle is the angle (degrees) that defines a sharp edge for normal splitting, and the angle used to select the edges extracted by the FEATURE_EDGES representation (default 30). Splitting controls whether sharp edges cause point duplication so that normals are discontinuous across them (default on).

◆ GetFeatureAngle()

double vtkSurfaceRepresentation::GetFeatureAngle ( )

Normal generation (forwarded to vtkGeometryFilterDispatcher).

GeneratePointNormals enables smooth-shading normals (default off). GenerateCellNormals enables flat-shading normals (default off). FeatureAngle is the angle (degrees) that defines a sharp edge for normal splitting, and the angle used to select the edges extracted by the FEATURE_EDGES representation (default 30). Splitting controls whether sharp edges cause point duplication so that normals are discontinuous across them (default on).

◆ SetSplitting()

void vtkSurfaceRepresentation::SetSplitting ( bool val)

Normal generation (forwarded to vtkGeometryFilterDispatcher).

GeneratePointNormals enables smooth-shading normals (default off). GenerateCellNormals enables flat-shading normals (default off). FeatureAngle is the angle (degrees) that defines a sharp edge for normal splitting, and the angle used to select the edges extracted by the FEATURE_EDGES representation (default 30). Splitting controls whether sharp edges cause point duplication so that normals are discontinuous across them (default on).

◆ GetSplitting()

bool vtkSurfaceRepresentation::GetSplitting ( )

Normal generation (forwarded to vtkGeometryFilterDispatcher).

GeneratePointNormals enables smooth-shading normals (default off). GenerateCellNormals enables flat-shading normals (default off). FeatureAngle is the angle (degrees) that defines a sharp edge for normal splitting, and the angle used to select the edges extracted by the FEATURE_EDGES representation (default 30). Splitting controls whether sharp edges cause point duplication so that normals are discontinuous across them (default on).

◆ SetTriangulate()

void vtkSurfaceRepresentation::SetTriangulate ( bool val)

Mesh processing options (forwarded to vtkGeometryFilterDispatcher).

Triangulate forces triangulation of the output (default off). NonlinearSubdivisionLevel controls subdivision of nonlinear cells for better approximation (default 1). MatchBoundariesIgnoringCellOrder removes internal faces between volumetric cells of different order (default off).

◆ GetTriangulate()

bool vtkSurfaceRepresentation::GetTriangulate ( )

Mesh processing options (forwarded to vtkGeometryFilterDispatcher).

Triangulate forces triangulation of the output (default off). NonlinearSubdivisionLevel controls subdivision of nonlinear cells for better approximation (default 1). MatchBoundariesIgnoringCellOrder removes internal faces between volumetric cells of different order (default off).

◆ SetNonlinearSubdivisionLevel()

void vtkSurfaceRepresentation::SetNonlinearSubdivisionLevel ( int val)

Mesh processing options (forwarded to vtkGeometryFilterDispatcher).

Triangulate forces triangulation of the output (default off). NonlinearSubdivisionLevel controls subdivision of nonlinear cells for better approximation (default 1). MatchBoundariesIgnoringCellOrder removes internal faces between volumetric cells of different order (default off).

◆ GetNonlinearSubdivisionLevel()

int vtkSurfaceRepresentation::GetNonlinearSubdivisionLevel ( )

Mesh processing options (forwarded to vtkGeometryFilterDispatcher).

Triangulate forces triangulation of the output (default off). NonlinearSubdivisionLevel controls subdivision of nonlinear cells for better approximation (default 1). MatchBoundariesIgnoringCellOrder removes internal faces between volumetric cells of different order (default off).

◆ SetMatchBoundariesIgnoringCellOrder()

void vtkSurfaceRepresentation::SetMatchBoundariesIgnoringCellOrder ( bool val)

Mesh processing options (forwarded to vtkGeometryFilterDispatcher).

Triangulate forces triangulation of the output (default off). NonlinearSubdivisionLevel controls subdivision of nonlinear cells for better approximation (default 1). MatchBoundariesIgnoringCellOrder removes internal faces between volumetric cells of different order (default off).

◆ GetMatchBoundariesIgnoringCellOrder()

bool vtkSurfaceRepresentation::GetMatchBoundariesIgnoringCellOrder ( )

Mesh processing options (forwarded to vtkGeometryFilterDispatcher).

Triangulate forces triangulation of the output (default off). NonlinearSubdivisionLevel controls subdivision of nonlinear cells for better approximation (default 1). MatchBoundariesIgnoringCellOrder removes internal faces between volumetric cells of different order (default off).

◆ SetPassThroughCellIds()

void vtkSurfaceRepresentation::SetPassThroughCellIds ( bool val)

Picking support (forwarded to vtkGeometryFilterDispatcher).

When on, the output contains arrays mapping surface cells/points back to original input cell/point ids (default on).

◆ GetPassThroughCellIds()

bool vtkSurfaceRepresentation::GetPassThroughCellIds ( )

Picking support (forwarded to vtkGeometryFilterDispatcher).

When on, the output contains arrays mapping surface cells/points back to original input cell/point ids (default on).

◆ SetPassThroughPointIds()

void vtkSurfaceRepresentation::SetPassThroughPointIds ( bool val)

Picking support (forwarded to vtkGeometryFilterDispatcher).

When on, the output contains arrays mapping surface cells/points back to original input cell/point ids (default on).

◆ GetPassThroughPointIds()

bool vtkSurfaceRepresentation::GetPassThroughPointIds ( )

Picking support (forwarded to vtkGeometryFilterDispatcher).

When on, the output contains arrays mapping surface cells/points back to original input cell/point ids (default on).

◆ SetBlockColorsDistinctValues()

void vtkSurfaceRepresentation::SetBlockColorsDistinctValues ( int val)

Composite and AMR options (forwarded to vtkGeometryFilterDispatcher).

BlockColorsDistinctValues sets the number of distinct values used in the vtkBlockColors array for composite datasets (default 7). HideInternalAMRFaces hides internal faces within AMR grids (default on). UseNonOverlappingAMRMetaDataForOutlines uses AMR metadata to generate outlines even for blocks without heavy data (default on).

◆ GetBlockColorsDistinctValues()

int vtkSurfaceRepresentation::GetBlockColorsDistinctValues ( )

Composite and AMR options (forwarded to vtkGeometryFilterDispatcher).

BlockColorsDistinctValues sets the number of distinct values used in the vtkBlockColors array for composite datasets (default 7). HideInternalAMRFaces hides internal faces within AMR grids (default on). UseNonOverlappingAMRMetaDataForOutlines uses AMR metadata to generate outlines even for blocks without heavy data (default on).

◆ SetHideInternalAMRFaces()

void vtkSurfaceRepresentation::SetHideInternalAMRFaces ( bool val)

Composite and AMR options (forwarded to vtkGeometryFilterDispatcher).

BlockColorsDistinctValues sets the number of distinct values used in the vtkBlockColors array for composite datasets (default 7). HideInternalAMRFaces hides internal faces within AMR grids (default on). UseNonOverlappingAMRMetaDataForOutlines uses AMR metadata to generate outlines even for blocks without heavy data (default on).

◆ GetHideInternalAMRFaces()

bool vtkSurfaceRepresentation::GetHideInternalAMRFaces ( )

Composite and AMR options (forwarded to vtkGeometryFilterDispatcher).

BlockColorsDistinctValues sets the number of distinct values used in the vtkBlockColors array for composite datasets (default 7). HideInternalAMRFaces hides internal faces within AMR grids (default on). UseNonOverlappingAMRMetaDataForOutlines uses AMR metadata to generate outlines even for blocks without heavy data (default on).

◆ SetUseNonOverlappingAMRMetaDataForOutlines()

void vtkSurfaceRepresentation::SetUseNonOverlappingAMRMetaDataForOutlines ( bool val)

Composite and AMR options (forwarded to vtkGeometryFilterDispatcher).

BlockColorsDistinctValues sets the number of distinct values used in the vtkBlockColors array for composite datasets (default 7). HideInternalAMRFaces hides internal faces within AMR grids (default on). UseNonOverlappingAMRMetaDataForOutlines uses AMR metadata to generate outlines even for blocks without heavy data (default on).

◆ GetUseNonOverlappingAMRMetaDataForOutlines()

bool vtkSurfaceRepresentation::GetUseNonOverlappingAMRMetaDataForOutlines ( )

Composite and AMR options (forwarded to vtkGeometryFilterDispatcher).

BlockColorsDistinctValues sets the number of distinct values used in the vtkBlockColors array for composite datasets (default 7). HideInternalAMRFaces hides internal faces within AMR grids (default on). UseNonOverlappingAMRMetaDataForOutlines uses AMR metadata to generate outlines even for blocks without heavy data (default on).

◆ SetGenerateProcessIds()

void vtkSurfaceRepresentation::SetGenerateProcessIds ( bool val)

Parallel option (forwarded to vtkGeometryFilterDispatcher).

When on, point and cell arrays named vtkProcessId are added to identify which MPI rank produced each element (default auto).

◆ GetGenerateProcessIds()

bool vtkSurfaceRepresentation::GetGenerateProcessIds ( )

Parallel option (forwarded to vtkGeometryFilterDispatcher).

When on, point and cell arrays named vtkProcessId are added to identify which MPI rank produced each element (default auto).

◆ SetVisibility()

void vtkSurfaceRepresentation::SetVisibility ( bool val)

Visibility, pickability, and actor transforms.

◆ GetVisibility()

bool vtkSurfaceRepresentation::GetVisibility ( )

Visibility, pickability, and actor transforms.

◆ SetPickable()

void vtkSurfaceRepresentation::SetPickable ( bool val)

Visibility, pickability, and actor transforms.

◆ GetPickable()

bool vtkSurfaceRepresentation::GetPickable ( )

Visibility, pickability, and actor transforms.

◆ SetPosition()

void vtkSurfaceRepresentation::SetPosition ( double x,
double y,
double z )

Visibility, pickability, and actor transforms.

◆ GetPosition()

double * vtkSurfaceRepresentation::GetPosition ( )

Visibility, pickability, and actor transforms.

◆ SetOrientation()

void vtkSurfaceRepresentation::SetOrientation ( double x,
double y,
double z )

Visibility, pickability, and actor transforms.

◆ GetOrientation()

double * vtkSurfaceRepresentation::GetOrientation ( )

Visibility, pickability, and actor transforms.

◆ SetScale()

void vtkSurfaceRepresentation::SetScale ( double x,
double y,
double z )

Visibility, pickability, and actor transforms.

◆ GetScale()

double * vtkSurfaceRepresentation::GetScale ( )

Visibility, pickability, and actor transforms.

◆ SetScalarBarVisibility()

void vtkSurfaceRepresentation::SetScalarBarVisibility ( bool val)

Scalar bar control.

◆ GetScalarBarVisibility()

bool vtkSurfaceRepresentation::GetScalarBarVisibility ( )

Scalar bar control.

◆ GetScalarBarActor()

vtkScalarBarActor * vtkSurfaceRepresentation::GetScalarBarActor ( )

Scalar bar control.

◆ SetSelectionColor()

void vtkSurfaceRepresentation::SetSelectionColor ( double r,
double g,
double b )

Selection display properties.

These control the appearance of highlighted cells or points when a selection is active. Defaults: red color, wireframe, line width 2, opacity 1.

◆ GetSelectionColor()

double * vtkSurfaceRepresentation::GetSelectionColor ( )

Selection display properties.

These control the appearance of highlighted cells or points when a selection is active. Defaults: red color, wireframe, line width 2, opacity 1.

◆ SetSelectionOpacity()

void vtkSurfaceRepresentation::SetSelectionOpacity ( double val)

Selection display properties.

These control the appearance of highlighted cells or points when a selection is active. Defaults: red color, wireframe, line width 2, opacity 1.

◆ GetSelectionOpacity()

double vtkSurfaceRepresentation::GetSelectionOpacity ( )

Selection display properties.

These control the appearance of highlighted cells or points when a selection is active. Defaults: red color, wireframe, line width 2, opacity 1.

◆ SetSelectionLineWidth()

void vtkSurfaceRepresentation::SetSelectionLineWidth ( double val)

Selection display properties.

These control the appearance of highlighted cells or points when a selection is active. Defaults: red color, wireframe, line width 2, opacity 1.

◆ GetSelectionLineWidth()

double vtkSurfaceRepresentation::GetSelectionLineWidth ( )

Selection display properties.

These control the appearance of highlighted cells or points when a selection is active. Defaults: red color, wireframe, line width 2, opacity 1.

◆ SetSelectionPointSize()

void vtkSurfaceRepresentation::SetSelectionPointSize ( double val)

Selection display properties.

These control the appearance of highlighted cells or points when a selection is active. Defaults: red color, wireframe, line width 2, opacity 1.

◆ GetSelectionPointSize()

double vtkSurfaceRepresentation::GetSelectionPointSize ( )

Selection display properties.

These control the appearance of highlighted cells or points when a selection is active. Defaults: red color, wireframe, line width 2, opacity 1.

◆ SetSelectionRepresentation()

void vtkSurfaceRepresentation::SetSelectionRepresentation ( int type)

The selection is drawn from the same geometry as the representation itself, so only the property-level RepresentationType values (POINTS, WIREFRAME, SURFACE, SURFACE_WITH_EDGES) apply here.

OUTLINE and FEATURE_EDGES are rejected with a warning.

Until this is set, the selection style follows the selection itself: point selections are drawn as points and cell selections as wireframe. Calling this setter pins the style to the requested value for every subsequent selection. The getter always reports the style in effect.

◆ GetSelectionRepresentation()

int vtkSurfaceRepresentation::GetSelectionRepresentation ( )

Selection display properties.

These control the appearance of highlighted cells or points when a selection is active. Defaults: red color, wireframe, line width 2, opacity 1.

◆ GetSelectionActor()

vtkActor * vtkSurfaceRepresentation::GetSelectionActor ( )

Provide access to the internal selection actor for advanced usage.

◆ GetActor()

vtkActor * vtkSurfaceRepresentation::GetActor ( )

Provide access to the internal actor for advanced usage.

◆ RequestData()

int vtkSurfaceRepresentation::RequestData ( vtkInformation * ,
vtkInformationVector ** ,
vtkInformationVector *  )
overrideprotectedvirtual

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 vtkDataRepresentation.

◆ AddToView()

bool vtkSurfaceRepresentation::AddToView ( vtkView * view)
overrideprotectedvirtual

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 vtkDataRepresentation.

◆ RemoveFromView()

bool vtkSurfaceRepresentation::RemoveFromView ( vtkView * view)
overrideprotectedvirtual

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 vtkDataRepresentation.

◆ ConvertSelection()

vtkSelection * vtkSurfaceRepresentation::ConvertSelection ( vtkView * view,
vtkSelection * selection )
overrideprotectedvirtual

Convert the selection to a type appropriate for sharing with other representations through vtkAnnotationLink, possibly using the view.

For the superclass, we just return the same selection. Subclasses may do something more fancy, like convert the selection from a frustum to a list of pedigree ids. If the selection cannot be applied to this representation, return nullptr.

Reimplemented from vtkDataRepresentation.


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