|
VTK
9.7.20260904
|
#include <vtkSurfaceRepresentation.h>
Renders any dataset as a surface.
vtkSurfaceRepresentation is a data representation that renders any dataset as a surface. Non-polygonal inputs are converted by vtkGeometryFilterDispatcher, which handles vtkDataSet, vtkHyperTreeGrid, vtkCellGrid, vtkGenericDataSet and composite datasets, and selections made in a view are extracted and drawn highlighted over the surface.
The API here covers what it takes to make data visible – whether it is drawn, how, and how opaque – and legible – what color, and colored by which array. Everything else is a property of the objects underneath, which are reachable through GetProperty(), GetMapper(), GetGeometryFilter() and GetActor(): line width, point size, lighting and the physically based properties on the property; normal generation, feature angle, triangulation, subdivision and the AMR and composite options on the geometry filter.
* Input (any dataset) * -> vtkGeometryFilterDispatcher (extract outer surface) * -> vtkCompositePolyDataMapper * -> vtkActor *
Definition at line 59 of file vtkSurfaceRepresentation.h.
Public Types | |
| enum | RepresentationType { POINTS = 0 , WIREFRAME = 1 , SURFACE = 2 , SURFACE_WITH_EDGES = 3 , OUTLINE = 4 , FEATURE_EDGES = 5 } |
| Representation type constants. More... | |
| typedef vtkScivisDataRepresentation | Superclass |
| Public Types inherited from vtkScivisDataRepresentation | |
| typedef vtkScivisRepresentation | Superclass |
| Public Types inherited from vtkScivisRepresentation | |
| 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. | |
| vtkSurfaceRepresentation * | NewInstance () 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 and actor it owns rather than in its own ivars. | |
| vtkBlockProperties * | GetBlocks () |
| Per-block appearance for a composite input: whether a block is drawn, and in what color and opacity, by flat block index. | |
| 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) |
| The color the surface is drawn in when it is not colored by an array, and how opaque it is. | |
| double * | GetColor () |
| The color the surface is drawn in when it is not colored by an array, and how opaque it is. | |
| void | SetOpacity (double val) |
| The color the surface is drawn in when it is not colored by an array, and how opaque it is. | |
| double | GetOpacity () |
| The color the surface is drawn in when it is not colored by an array, and how opaque it is. | |
| void | SetEdgeColor (double r, double g, double b) |
| The color the surface is drawn in when it is not colored by an array, and how opaque it is. | |
| double * | GetEdgeColor () |
| The color the surface is drawn in when it is not colored by an array, and how opaque it is. | |
| void | SetScalarVisibility (bool val) |
| Color by an array rather than by a single color. | |
| bool | GetScalarVisibility () |
| Color by an array rather than by a single color. | |
| void | ColorByPointArray (const char *arrayName) |
| Color by an array rather than by a single color. | |
| void | ColorByPointArray (const char *arrayName, int component) |
| Color by an array rather than by a single color. | |
| void | ColorByCellArray (const char *arrayName) |
| Color by an array rather than by a single color. | |
| void | ColorByCellArray (const char *arrayName, int component) |
| Color by an array rather than by a single color. | |
| void | ColorByFieldArray (const char *arrayName) |
| Color by an array rather than by a single color. | |
| void | ColorByFieldArray (const char *arrayName, int component) |
| Color by an array rather than by a single color. | |
| void | ResetColorArray () |
| Color by an array rather than by a single color. | |
| 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 | SetInterpolateScalarsBeforeMapping (bool val) |
| Whether scalars are interpolated across a cell before being turned into colors rather than after. | |
| bool | GetInterpolateScalarsBeforeMapping () |
| Whether scalars are interpolated across a cell before being turned into colors rather than after. | |
| void | SetVisibility (bool val) override |
| The vtkScivisDataRepresentation contract. | |
| bool | GetVisibility () override |
| The vtkScivisDataRepresentation contract. | |
| bool | GetBounds (double bounds[6]) override |
| The vtkScivisDataRepresentation contract. | |
| const char * | GetRenderedArrayName () override |
| The vtkScivisDataRepresentation contract. | |
| int | GetRenderedFieldAssociation () override |
| The vtkScivisDataRepresentation contract. | |
| bool | GetDataRange (const char *arrayName, int fieldAssoc, double range[2], int component=-1) override |
| The vtkScivisDataRepresentation contract. | |
| void | SetColorMap (vtkScalarsToColors *map) override |
| The vtkScivisDataRepresentation contract. | |
| vtkScalarsToColors * | GetColorMap () override |
| The vtkScivisDataRepresentation contract. | |
| void | SetSelectionRepresentation (int type) |
| How a selection made in a view is drawn over the surface. | |
| int | GetSelectionRepresentation () |
| How a selection made in a view is drawn over the surface. | |
| vtkActor * | GetActor () |
| The objects this representation is built from, for everything the API above does not cover. | |
| vtkProperty * | GetProperty () |
| The objects this representation is built from, for everything the API above does not cover. | |
| vtkGeometryFilterDispatcher * | GetGeometryFilter () |
| The objects this representation is built from, for everything the API above does not cover. | |
| vtkActor * | GetSelectionActor () |
| The objects this representation is built from, for everything the API above does not cover. | |
| Public Member Functions inherited from vtkScivisDataRepresentation | |
| vtkScivisDataRepresentation * | NewInstance () const |
| vtkAlgorithmOutput * | GetInternalOutputPort () |
| A shallow copy of an input, kept up to date, that the filters inside a representation can be connected to without holding its own pipeline open. | |
| vtkAlgorithmOutput * | GetInternalOutputPort (int port) |
| virtual vtkAlgorithmOutput * | GetInternalOutputPort (int port, int conn) |
| void | Select (vtkScivisView *view, vtkSelection *selection) |
| Hand this representation a selection made in view. | |
| void | Select (vtkScivisView *view, vtkSelection *selection, bool extend) |
| vtkSelection * | GetCurrentSelection () |
| What this representation currently has selected, or null. | |
| void | AddClippingPlane (vtkPlane *plane) |
| Planes that cut away part of what this representation draws. | |
| void | RemoveClippingPlane (vtkPlane *plane) |
| Planes that cut away part of what this representation draws. | |
| void | RemoveAllClippingPlanes () |
| Planes that cut away part of what this representation draws. | |
| void | SetClippingPlanes (vtkPlaneCollection *planes) |
| Planes that cut away part of what this representation draws. | |
| vtkPlaneCollection * | GetClippingPlanes () |
| Planes that cut away part of what this representation draws. | |
| int | GetNumberOfClippingPlanes () |
| Planes that cut away part of what this representation draws. | |
| virtual void | SetSelectable (bool) |
| Whether a view may select in this representation at all. | |
| virtual bool | GetSelectable () |
| Whether a view may select in this representation at all. | |
| virtual void | SelectableOn () |
| Whether a view may select in this representation at all. | |
| virtual void | SelectableOff () |
| Whether a view may select in this representation at all. | |
| Public Member Functions inherited from vtkScivisRepresentation | |
| vtkScivisRepresentation * | NewInstance () const |
| Public Member Functions inherited from vtkPassInputTypeAlgorithm | |
| vtkPassInputTypeAlgorithm * | NewInstance () const |
| vtkDataObject * | GetInput () |
| Get the input data object. | |
| vtkTypeBool | ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override |
| see vtkAlgorithm for details | |
| vtkDataObject * | GetOutput () |
| Get the output data object for a port on this algorithm. | |
| vtkDataObject * | GetOutput (int) |
| Get the output data object for a port on this algorithm. | |
| vtkPolyData * | GetPolyDataOutput () |
| Get the output as a concrete type. | |
| vtkStructuredPoints * | GetStructuredPointsOutput () |
| Get the output as a concrete type. | |
| vtkImageData * | GetImageDataOutput () |
| Get the output as a concrete type. | |
| vtkStructuredGrid * | GetStructuredGridOutput () |
| Get the output as a concrete type. | |
| vtkUnstructuredGrid * | GetUnstructuredGridOutput () |
| Get the output as a concrete type. | |
| vtkRectilinearGrid * | GetRectilinearGridOutput () |
| Get the output as a concrete type. | |
| vtkGraph * | GetGraphOutput () |
| Get the output as a concrete type. | |
| vtkMolecule * | GetMoleculeOutput () |
| Get the output as a concrete type. | |
| vtkTable * | GetTableOutput () |
| Get the output as a concrete type. | |
| vtkHyperTreeGrid * | GetHyperTreeGridOutput () |
| 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 | |
| vtkAlgorithm * | NewInstance () const |
| vtkTypeBool | HasExecutive () |
| Check whether this algorithm has an assigned executive. | |
| vtkExecutive * | GetExecutive () |
| 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. | |
| vtkInformation * | GetInputPortInformation (int port) |
| Get the information object associated with an input port. | |
| vtkInformation * | GetOutputPortInformation (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 () |
| Check to see if an input's ABORTED flag is set or if an upstream algorithm's AbortExecute is set. | |
| bool | CheckAbortAndInvoke () |
| Invoke AbortCheck event then return CheckAbort result. | |
| void | InvokeCleanupAbortCheck () |
| Invoke CleanupAbortCheck event, usually used by application to cleanup multi process communications triggered by CheckAbortAndInvoke. | |
| 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). | |
| vtkInformation * | GetInputArrayInformation (int idx) |
| Get the info object for the specified input array to this algorithm. | |
| void | RemoveAllInputs () |
| Remove all the input data. | |
| vtkDataObject * | GetOutputDataObject (int port) |
| Get the data object that will contain the algorithm output for the given port. | |
| vtkDataObject * | GetInputDataObject (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) |
| vtkAlgorithmOutput * | GetOutputPort (int index) |
| Get a proxy object corresponding to the given output port of this algorithm. | |
| vtkAlgorithmOutput * | GetOutputPort () |
| 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. | |
| vtkAlgorithmOutput * | GetInputConnection (int port, int index) |
| Get the algorithm output port connected to an input port. | |
| vtkAlgorithm * | GetInputAlgorithm (int port, int index, int &algPort) |
| Returns the algorithm and the output port index of that algorithm connected to a port-index pair. | |
| vtkAlgorithm * | GetInputAlgorithm (int port, int index) |
| Returns the algorithm connected to a port-index pair. | |
| vtkAlgorithm * | GetInputAlgorithm () |
| Equivalent to GetInputAlgorithm(0, 0). | |
| vtkExecutive * | GetInputExecutive (int port, int index) |
| Returns the executive associated with a particular input connection. | |
| vtkExecutive * | GetInputExecutive () |
| Equivalent to GetInputExecutive(0, 0). | |
| vtkInformation * | GetInputInformation (int port, int index) |
| Return the information object that is associated with a particular input connection. | |
| vtkInformation * | GetInputInformation () |
| Equivalent to GetInputInformation(0, 0). | |
| vtkInformation * | GetOutputInformation (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 vtkInformation * | GetInformation () |
| 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. | |
| vtkAlgorithm * | GetContainerAlgorithm () |
| 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 vtkProgressObserver * | GetProgressObserver () |
| 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. | |
| vtkCommand * | GetCommand (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 vtkSurfaceRepresentation * | New () |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkSurfaceRepresentation * | SafeDownCast (vtkObjectBase *o) |
| Static Public Member Functions inherited from vtkScivisDataRepresentation | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkScivisDataRepresentation * | SafeDownCast (vtkObjectBase *o) |
| Static Public Member Functions inherited from vtkScivisRepresentation | |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkScivisRepresentation * | SafeDownCast (vtkObjectBase *o) |
| Static Public Member Functions inherited from vtkPassInputTypeAlgorithm | |
| static vtkPassInputTypeAlgorithm * | New () |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkPassInputTypeAlgorithm * | SafeDownCast (vtkObjectBase *o) |
| Static Public Member Functions inherited from vtkAlgorithm | |
| static vtkAlgorithm * | New () |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkAlgorithm * | SafeDownCast (vtkObjectBase *o) |
| static vtkInformationIntegerKey * | INPUT_IS_OPTIONAL () |
| Keys used to specify input port requirements. | |
| static vtkInformationIntegerKey * | INPUT_IS_REPEATABLE () |
| static vtkInformationInformationVectorKey * | INPUT_REQUIRED_FIELDS () |
| static vtkInformationStringVectorKey * | INPUT_REQUIRED_DATA_TYPE () |
| static vtkInformationInformationVectorKey * | INPUT_ARRAYS_TO_PROCESS () |
| static vtkInformationIntegerKey * | INPUT_PORT () |
| static vtkInformationIntegerKey * | INPUT_CONNECTION () |
| static vtkInformationIntegerKey * | CAN_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 vtkInformationIntegerKey * | CAN_HANDLE_PIECE_REQUEST () |
| Key that tells the pipeline that a particular algorithm can or cannot handle piece request. | |
| static vtkInformationIntegerKey * | ABORTED () |
| 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 vtkObject * | New () |
| 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 vtkObjectBase * | New () |
| 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 vtkObjectBase * | NewInstanceInternal () const |
| vtkSurfaceRepresentation () | |
| ~vtkSurfaceRepresentation () override | |
| int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override |
| This is called within ProcessRequest when a request asks the algorithm to do its work. | |
| bool | AddToView (vtkScivisView *view) override |
| Called when this representation is added to or removed from a view. | |
| bool | RemoveFromView (vtkScivisView *view) override |
| Called when this representation is added to or removed from a view. | |
| vtkSelection * | ConvertSelection (vtkScivisView *view, vtkSelection *selection) override |
| Turn a selection made in view into one expressed over this representation's own input. | |
| Protected Member Functions inherited from vtkScivisDataRepresentation | |
| vtkScivisDataRepresentation () | |
| ~vtkScivisDataRepresentation () override | |
| virtual void | UpdateSelection (vtkSelection *selection, bool extend) |
| Make selection current and fire SelectionChangedEvent. | |
| Protected Member Functions inherited from vtkScivisRepresentation | |
| vtkScivisRepresentation () | |
| ~vtkScivisRepresentation () override | |
| 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. | |
| vtkDataObject * | GetInput (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. | |
| vtkInformation * | GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector) |
| This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. | |
| virtual vtkExecutive * | CreateDefaultExecutive () |
| 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. | |
| vtkDataArray * | GetInputArrayToProcess (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. | |
| vtkDataArray * | GetInputArrayToProcess (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. | |
| vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector) |
| Filters that have multiple connections on one port can use this signature. | |
| vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association) |
| Filters that have multiple connections on one port can use this signature. | |
| vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input) |
| Filters that have multiple connections on one port can use this signature. | |
| vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input, int &association) |
| Filters that have multiple connections on one port can use this signature. | |
| vtkAbstractArray * | GetInputAbstractArrayToProcess (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. | |
| vtkAbstractArray * | GetInputAbstractArrayToProcess (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. | |
| vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector) |
| Filters that have multiple connections on one port can use this signature. | |
| vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association) |
| Filters that have multiple connections on one port can use this signature. | |
| vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input) |
| Filters that have multiple connections on one port can use this signature. | |
| vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association) |
| Filters that have multiple connections on one port can use this signature. | |
| vtkSmartPointer< vtkAbstractArray > | GetInputArray (int idx, int connection, vtkInformationVector **inputVector, int &association, int requestedComponent=vtkArrayComponents::Requested) |
| Get an array from the input at index idx. | |
| vtkSmartPointer< vtkAbstractArray > | GetInputArray (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 &) |
| enum | ColorModeType { MAP_SCALARS = 0 , DIRECT_SCALARS = 1 } |
| How the values of the color array become colors. More... | |
| void | SetColorMode (int mode) |
| How the values of the color array become colors. | |
| int | GetColorMode () |
| How the values of the color array become colors. | |
| void | SetColorModeToMapScalars () |
| How the values of the color array become colors. | |
| void | SetColorModeToDirectScalars () |
| How the values of the color array become colors. | |
Definition at line 63 of file vtkSurfaceRepresentation.h.
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 83 of file vtkSurfaceRepresentation.h.
How the values of the color array become colors.
The default maps them through the color map. DIRECT_SCALARS instead takes an unsigned char array of three or four components as the colors themselves, which is how data that already carries its own colors is drawn.
| Enumerator | |
|---|---|
| MAP_SCALARS | |
| DIRECT_SCALARS | |
Definition at line 170 of file vtkSurfaceRepresentation.h.
|
protected |
|
overrideprotected |
|
static |
|
static |
|
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 vtkScivisDataRepresentation.
|
static |
|
protectedvirtual |
Reimplemented from vtkScivisDataRepresentation.
| vtkSurfaceRepresentation * vtkSurfaceRepresentation::NewInstance | ( | ) | const |
|
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 vtkScivisDataRepresentation.
|
overridevirtual |
The representation stores its properties on the geometry filter, mapper and actor it owns rather than in its own ivars.
Those objects are also reachable through GetActor() and friends, so the modified time reported here is the latest of this object's own and theirs.
Reimplemented from vtkObject.
| 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.
| 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.
|
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 105 of file vtkSurfaceRepresentation.h.
|
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 106 of file vtkSurfaceRepresentation.h.
|
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 107 of file vtkSurfaceRepresentation.h.
|
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 108 of file vtkSurfaceRepresentation.h.
|
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 109 of file vtkSurfaceRepresentation.h.
|
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 110 of file vtkSurfaceRepresentation.h.
| 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.
| void vtkSurfaceRepresentation::SetColor | ( | double | r, |
| double | g, | ||
| double | b ) |
The color the surface is drawn in when it is not colored by an array, and how opaque it is.
EdgeColor is the color of the edges drawn by the SURFACE_WITH_EDGES mode.
For the rest of the appearance – line width, point size, lighting, ambient, diffuse, specular, roughness, metallic – use GetProperty().
| double * vtkSurfaceRepresentation::GetColor | ( | ) |
The color the surface is drawn in when it is not colored by an array, and how opaque it is.
EdgeColor is the color of the edges drawn by the SURFACE_WITH_EDGES mode.
For the rest of the appearance – line width, point size, lighting, ambient, diffuse, specular, roughness, metallic – use GetProperty().
| void vtkSurfaceRepresentation::SetOpacity | ( | double | val | ) |
The color the surface is drawn in when it is not colored by an array, and how opaque it is.
EdgeColor is the color of the edges drawn by the SURFACE_WITH_EDGES mode.
For the rest of the appearance – line width, point size, lighting, ambient, diffuse, specular, roughness, metallic – use GetProperty().
| double vtkSurfaceRepresentation::GetOpacity | ( | ) |
The color the surface is drawn in when it is not colored by an array, and how opaque it is.
EdgeColor is the color of the edges drawn by the SURFACE_WITH_EDGES mode.
For the rest of the appearance – line width, point size, lighting, ambient, diffuse, specular, roughness, metallic – use GetProperty().
| void vtkSurfaceRepresentation::SetEdgeColor | ( | double | r, |
| double | g, | ||
| double | b ) |
The color the surface is drawn in when it is not colored by an array, and how opaque it is.
EdgeColor is the color of the edges drawn by the SURFACE_WITH_EDGES mode.
For the rest of the appearance – line width, point size, lighting, ambient, diffuse, specular, roughness, metallic – use GetProperty().
| double * vtkSurfaceRepresentation::GetEdgeColor | ( | ) |
The color the surface is drawn in when it is not colored by an array, and how opaque it is.
EdgeColor is the color of the edges drawn by the SURFACE_WITH_EDGES mode.
For the rest of the appearance – line width, point size, lighting, ambient, diffuse, specular, roughness, metallic – use GetProperty().
| void vtkSurfaceRepresentation::SetScalarVisibility | ( | bool | val | ) |
Color by an array rather than by a single color.
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: its tuples are consumed one per cell. ResetColorArray goes back to whatever the data's active scalars are.
The overloads taking a component select which component of a multi-component array to map; the others map the array as the color map sees fit, which for vectors is the magnitude.
The range that scalars are mapped through belongs to the color map, not to the representation: set it with GetColorMap()->SetRange(), or on a map of your own before handing it over. A map shared between representations therefore keeps one range, and the representation never writes over the range you gave it.
| bool vtkSurfaceRepresentation::GetScalarVisibility | ( | ) |
Color by an array rather than by a single color.
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: its tuples are consumed one per cell. ResetColorArray goes back to whatever the data's active scalars are.
The overloads taking a component select which component of a multi-component array to map; the others map the array as the color map sees fit, which for vectors is the magnitude.
The range that scalars are mapped through belongs to the color map, not to the representation: set it with GetColorMap()->SetRange(), or on a map of your own before handing it over. A map shared between representations therefore keeps one range, and the representation never writes over the range you gave it.
| void vtkSurfaceRepresentation::ColorByPointArray | ( | const char * | arrayName | ) |
Color by an array rather than by a single color.
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: its tuples are consumed one per cell. ResetColorArray goes back to whatever the data's active scalars are.
The overloads taking a component select which component of a multi-component array to map; the others map the array as the color map sees fit, which for vectors is the magnitude.
The range that scalars are mapped through belongs to the color map, not to the representation: set it with GetColorMap()->SetRange(), or on a map of your own before handing it over. A map shared between representations therefore keeps one range, and the representation never writes over the range you gave it.
| void vtkSurfaceRepresentation::ColorByPointArray | ( | const char * | arrayName, |
| int | component ) |
Color by an array rather than by a single color.
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: its tuples are consumed one per cell. ResetColorArray goes back to whatever the data's active scalars are.
The overloads taking a component select which component of a multi-component array to map; the others map the array as the color map sees fit, which for vectors is the magnitude.
The range that scalars are mapped through belongs to the color map, not to the representation: set it with GetColorMap()->SetRange(), or on a map of your own before handing it over. A map shared between representations therefore keeps one range, and the representation never writes over the range you gave it.
| void vtkSurfaceRepresentation::ColorByCellArray | ( | const char * | arrayName | ) |
Color by an array rather than by a single color.
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: its tuples are consumed one per cell. ResetColorArray goes back to whatever the data's active scalars are.
The overloads taking a component select which component of a multi-component array to map; the others map the array as the color map sees fit, which for vectors is the magnitude.
The range that scalars are mapped through belongs to the color map, not to the representation: set it with GetColorMap()->SetRange(), or on a map of your own before handing it over. A map shared between representations therefore keeps one range, and the representation never writes over the range you gave it.
| void vtkSurfaceRepresentation::ColorByCellArray | ( | const char * | arrayName, |
| int | component ) |
Color by an array rather than by a single color.
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: its tuples are consumed one per cell. ResetColorArray goes back to whatever the data's active scalars are.
The overloads taking a component select which component of a multi-component array to map; the others map the array as the color map sees fit, which for vectors is the magnitude.
The range that scalars are mapped through belongs to the color map, not to the representation: set it with GetColorMap()->SetRange(), or on a map of your own before handing it over. A map shared between representations therefore keeps one range, and the representation never writes over the range you gave it.
| void vtkSurfaceRepresentation::ColorByFieldArray | ( | const char * | arrayName | ) |
Color by an array rather than by a single color.
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: its tuples are consumed one per cell. ResetColorArray goes back to whatever the data's active scalars are.
The overloads taking a component select which component of a multi-component array to map; the others map the array as the color map sees fit, which for vectors is the magnitude.
The range that scalars are mapped through belongs to the color map, not to the representation: set it with GetColorMap()->SetRange(), or on a map of your own before handing it over. A map shared between representations therefore keeps one range, and the representation never writes over the range you gave it.
| void vtkSurfaceRepresentation::ColorByFieldArray | ( | const char * | arrayName, |
| int | component ) |
Color by an array rather than by a single color.
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: its tuples are consumed one per cell. ResetColorArray goes back to whatever the data's active scalars are.
The overloads taking a component select which component of a multi-component array to map; the others map the array as the color map sees fit, which for vectors is the magnitude.
The range that scalars are mapped through belongs to the color map, not to the representation: set it with GetColorMap()->SetRange(), or on a map of your own before handing it over. A map shared between representations therefore keeps one range, and the representation never writes over the range you gave it.
| void vtkSurfaceRepresentation::ResetColorArray | ( | ) |
Color by an array rather than by a single color.
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: its tuples are consumed one per cell. ResetColorArray goes back to whatever the data's active scalars are.
The overloads taking a component select which component of a multi-component array to map; the others map the array as the color map sees fit, which for vectors is the magnitude.
The range that scalars are mapped through belongs to the color map, not to the representation: set it with GetColorMap()->SetRange(), or on a map of your own before handing it over. A map shared between representations therefore keeps one range, and the representation never writes over the range you gave it.
| void vtkSurfaceRepresentation::SetColorMode | ( | int | mode | ) |
How the values of the color array become colors.
The default maps them through the color map. DIRECT_SCALARS instead takes an unsigned char array of three or four components as the colors themselves, which is how data that already carries its own colors is drawn.
| int vtkSurfaceRepresentation::GetColorMode | ( | ) |
How the values of the color array become colors.
The default maps them through the color map. DIRECT_SCALARS instead takes an unsigned char array of three or four components as the colors themselves, which is how data that already carries its own colors is drawn.
|
inline |
How the values of the color array become colors.
The default maps them through the color map. DIRECT_SCALARS instead takes an unsigned char array of three or four components as the colors themselves, which is how data that already carries its own colors is drawn.
Definition at line 177 of file vtkSurfaceRepresentation.h.
|
inline |
How the values of the color array become colors.
The default maps them through the color map. DIRECT_SCALARS instead takes an unsigned char array of three or four components as the colors themselves, which is how data that already carries its own colors is drawn.
Definition at line 178 of file vtkSurfaceRepresentation.h.
| 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 while coloring by a point or cell array.
| 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 while coloring by a point or cell array.
| void vtkSurfaceRepresentation::SetInterpolateScalarsBeforeMapping | ( | bool | val | ) |
Whether scalars are interpolated across a cell before being turned into colors rather than after.
Interpolating first is more faithful on a coarse mesh, at the cost of a texture lookup per fragment. Default is off.
| bool vtkSurfaceRepresentation::GetInterpolateScalarsBeforeMapping | ( | ) |
Whether scalars are interpolated across a cell before being turned into colors rather than after.
Interpolating first is more faithful on a coarse mesh, at the cost of a texture lookup per fragment. Default is off.
| vtkBlockProperties * vtkSurfaceRepresentation::GetBlocks | ( | ) |
Per-block appearance for a composite input: whether a block is drawn, and in what color and opacity, by flat block index.
Those live in an object of their own because addressing a block by index means walking the data to find it, which every one of them would otherwise have to remember to do:
|
overridevirtual |
The vtkScivisDataRepresentation contract.
The rendered array is resolved from the data, so it reports the active scalars when no array has been selected, and answers for the first block of a composite input that has anything to say. The range is reported over the input rather than over the extracted surface, so that it agrees with what a volume of the same data would say.
Implements vtkScivisRepresentation.
|
overridevirtual |
The vtkScivisDataRepresentation contract.
The rendered array is resolved from the data, so it reports the active scalars when no array has been selected, and answers for the first block of a composite input that has anything to say. The range is reported over the input rather than over the extracted surface, so that it agrees with what a volume of the same data would say.
Implements vtkScivisRepresentation.
|
overridevirtual |
The vtkScivisDataRepresentation contract.
The rendered array is resolved from the data, so it reports the active scalars when no array has been selected, and answers for the first block of a composite input that has anything to say. The range is reported over the input rather than over the extracted surface, so that it agrees with what a volume of the same data would say.
Implements vtkScivisDataRepresentation.
|
overridevirtual |
The vtkScivisDataRepresentation contract.
The rendered array is resolved from the data, so it reports the active scalars when no array has been selected, and answers for the first block of a composite input that has anything to say. The range is reported over the input rather than over the extracted surface, so that it agrees with what a volume of the same data would say.
Implements vtkScivisDataRepresentation.
|
overridevirtual |
The vtkScivisDataRepresentation contract.
The rendered array is resolved from the data, so it reports the active scalars when no array has been selected, and answers for the first block of a composite input that has anything to say. The range is reported over the input rather than over the extracted surface, so that it agrees with what a volume of the same data would say.
Implements vtkScivisDataRepresentation.
|
overridevirtual |
The vtkScivisDataRepresentation contract.
The rendered array is resolved from the data, so it reports the active scalars when no array has been selected, and answers for the first block of a composite input that has anything to say. The range is reported over the input rather than over the extracted surface, so that it agrees with what a volume of the same data would say.
Implements vtkScivisDataRepresentation.
|
overridevirtual |
The vtkScivisDataRepresentation contract.
The rendered array is resolved from the data, so it reports the active scalars when no array has been selected, and answers for the first block of a composite input that has anything to say. The range is reported over the input rather than over the extracted surface, so that it agrees with what a volume of the same data would say.
Implements vtkScivisDataRepresentation.
|
overridevirtual |
The vtkScivisDataRepresentation contract.
The rendered array is resolved from the data, so it reports the active scalars when no array has been selected, and answers for the first block of a composite input that has anything to say. The range is reported over the input rather than over the extracted surface, so that it agrees with what a volume of the same data would say.
Implements vtkScivisDataRepresentation.
| void vtkSurfaceRepresentation::SetSelectionRepresentation | ( | int | type | ) |
How a selection made in a view is drawn over the surface.
The selection is drawn from the same geometry as the representation itself, so only the property-level values (POINTS, WIREFRAME, SURFACE, SURFACE_WITH_EDGES) apply here; OUTLINE and FEATURE_EDGES are rejected with a warning.
Until this is set, the 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.
For the color, opacity, line width and point size of the highlight, use GetSelectionActor()->GetProperty().
| int vtkSurfaceRepresentation::GetSelectionRepresentation | ( | ) |
How a selection made in a view is drawn over the surface.
The selection is drawn from the same geometry as the representation itself, so only the property-level values (POINTS, WIREFRAME, SURFACE, SURFACE_WITH_EDGES) apply here; OUTLINE and FEATURE_EDGES are rejected with a warning.
Until this is set, the 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.
For the color, opacity, line width and point size of the highlight, use GetSelectionActor()->GetProperty().
| vtkActor * vtkSurfaceRepresentation::GetActor | ( | ) |
The objects this representation is built from, for everything the API above does not cover.
Note that the representation holds the geometry filter to the pass-through of original point and cell ids, which is what lets a selection made in a view be mapped back to the input. Turning that off breaks selection.
| vtkProperty * vtkSurfaceRepresentation::GetProperty | ( | ) |
The objects this representation is built from, for everything the API above does not cover.
Note that the representation holds the geometry filter to the pass-through of original point and cell ids, which is what lets a selection made in a view be mapped back to the input. Turning that off breaks selection.
| vtkGeometryFilterDispatcher * vtkSurfaceRepresentation::GetGeometryFilter | ( | ) |
The objects this representation is built from, for everything the API above does not cover.
Note that the representation holds the geometry filter to the pass-through of original point and cell ids, which is what lets a selection made in a view be mapped back to the input. Turning that off breaks selection.
| vtkActor * vtkSurfaceRepresentation::GetSelectionActor | ( | ) |
The objects this representation is built from, for everything the API above does not cover.
Note that the representation holds the geometry filter to the pass-through of original point and cell ids, which is what lets a selection made in a view be mapped back to the input. Turning that off breaks selection.
|
overrideprotectedvirtual |
This is called within ProcessRequest when a request asks the algorithm to do its work.
This is the method you should override to do whatever the algorithm is designed to do. This happens during the final pass in the pipeline execution process.
Reimplemented from vtkPassInputTypeAlgorithm.
|
overrideprotectedvirtual |
Called when this representation is added to or removed from a view.
Returning false from AddToView() refuses the view, and the view drops the representation again.
Reimplemented from vtkScivisRepresentation.
|
overrideprotectedvirtual |
Called when this representation is added to or removed from a view.
Returning false from AddToView() refuses the view, and the view drops the representation again.
Reimplemented from vtkScivisRepresentation.
|
overrideprotectedvirtual |
Turn a selection made in view into one expressed over this representation's own input.
The default returns it unchanged; return null to reject it.
Reimplemented from vtkScivisDataRepresentation.