VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkVolumeOutlineSource Class Reference

outline of volume cropping region More...

#include <vtkVolumeOutlineSource.h>

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

Public Types

typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
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. More...
 
vtkVolumeOutlineSourceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetVolumeMapper (vtkVolumeMapper *mapper)
 Set the mapper that has the cropping region that the outline will be generated for. More...
 
vtkVolumeMapperGetVolumeMapper ()
 
virtual void SetGenerateScalars (vtkTypeBool)
 Set whether to generate color scalars for the output. More...
 
virtual void GenerateScalarsOn ()
 
virtual void GenerateScalarsOff ()
 
virtual vtkTypeBool GetGenerateScalars ()
 
virtual void SetGenerateOutline (vtkTypeBool)
 Set whether to generate an outline wherever an input face was cut by a plane. More...
 
virtual void GenerateOutlineOn ()
 
virtual void GenerateOutlineOff ()
 
virtual vtkTypeBool GetGenerateOutline ()
 
virtual void SetGenerateFaces (vtkTypeBool)
 Set whether to generate polygonal faces for the output. More...
 
virtual void GenerateFacesOn ()
 
virtual void GenerateFacesOff ()
 
virtual vtkTypeBool GetGenerateFaces ()
 
virtual void SetColor (double, double, double)
 Set the color of the outline. More...
 
virtual void SetColor (double[3])
 
virtual doubleGetColor ()
 
virtual void GetColor (double &, double &, double &)
 
virtual void GetColor (double[3])
 
virtual void SetActivePlaneId (int)
 Set the active plane, e.g. More...
 
virtual int GetActivePlaneId ()
 
virtual void SetActivePlaneColor (double, double, double)
 Set the color of the active cropping plane. More...
 
virtual void SetActivePlaneColor (double[3])
 
virtual doubleGetActivePlaneColor ()
 
virtual void GetActivePlaneColor (double &, double &, double &)
 
virtual void GetActivePlaneColor (double[3])
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkVolumeOutlineSourceNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVolumeOutlineSourceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (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. More...
 
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. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkVolumeOutlineSource ()
 
 ~vtkVolumeOutlineSource () override
 
int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, int requestFromOutputPort, vtkMTimeType *mtime) override
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static int ComputeCubePlanes (double planes[3][4], double croppingPlanes[6], double bounds[6])
 
static void GeneratePolys (vtkCellArray *polys, vtkUnsignedCharArray *scalars, unsigned char colors[2][3], int activePlane, int flags, int tolPtId[3][4])
 
static void GenerateLines (vtkCellArray *lines, vtkUnsignedCharArray *scalars, unsigned char colors[2][3], int activePlane, int flags, int tolPtId[3][4])
 
static void GeneratePoints (vtkPoints *points, vtkCellArray *lines, vtkCellArray *polys, double planes[3][4], double tol)
 
static void NudgeCropPlanesToBounds (int tolPtId[3][4], double planes[3][4], double tol)
 
static void CreateColorValues (unsigned char colors[2][3], double color1[3], double color2[3])
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

vtkVolumeMapperVolumeMapper
 
vtkTypeBool GenerateScalars
 
vtkTypeBool GenerateOutline
 
vtkTypeBool GenerateFaces
 
int ActivePlaneId
 
double Color [3]
 
double ActivePlaneColor [3]
 
int Cropping
 
int CroppingRegionFlags
 
double Bounds [6]
 
double CroppingRegionPlanes [6]
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

outline of volume cropping region

vtkVolumeOutlineSource generates a wireframe outline that corresponds to the cropping region of a vtkVolumeMapper. It requires a vtkVolumeMapper as input. The GenerateFaces option turns on the solid faces of the outline, and the GenerateScalars option generates color scalars. When GenerateScalars is on, it is possible to set an "ActivePlaneId" value in the range [0..6] to highlight one of the six cropping planes.

Thanks:
Thanks to David Gobbi for contributing this class to VTK.

Definition at line 38 of file vtkVolumeOutlineSource.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkVolumeOutlineSource.h.

Constructor & Destructor Documentation

◆ vtkVolumeOutlineSource()

vtkVolumeOutlineSource::vtkVolumeOutlineSource ( )
protected

◆ ~vtkVolumeOutlineSource()

vtkVolumeOutlineSource::~vtkVolumeOutlineSource ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkVolumeOutlineSource* vtkVolumeOutlineSource::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkVolumeOutlineSource::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 vtkPolyDataAlgorithm.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkVolumeOutlineSource::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkVolumeOutlineSource* vtkVolumeOutlineSource::NewInstance ( ) const

◆ PrintSelf()

void vtkVolumeOutlineSource::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 vtkPolyDataAlgorithm.

◆ SetVolumeMapper()

virtual void vtkVolumeOutlineSource::SetVolumeMapper ( vtkVolumeMapper mapper)
virtual

Set the mapper that has the cropping region that the outline will be generated for.

The mapper must have an input, because the bounds of the data must be computed in order to generate the outline.

◆ GetVolumeMapper()

vtkVolumeMapper* vtkVolumeOutlineSource::GetVolumeMapper ( )
inline

Definition at line 53 of file vtkVolumeOutlineSource.h.

◆ SetGenerateScalars()

virtual void vtkVolumeOutlineSource::SetGenerateScalars ( vtkTypeBool  )
virtual

Set whether to generate color scalars for the output.

By default, the output has no scalars and the color must be set in the property of the actor.

◆ GenerateScalarsOn()

virtual void vtkVolumeOutlineSource::GenerateScalarsOn ( )
virtual

◆ GenerateScalarsOff()

virtual void vtkVolumeOutlineSource::GenerateScalarsOff ( )
virtual

◆ GetGenerateScalars()

virtual vtkTypeBool vtkVolumeOutlineSource::GetGenerateScalars ( )
virtual

◆ SetGenerateOutline()

virtual void vtkVolumeOutlineSource::SetGenerateOutline ( vtkTypeBool  )
virtual

Set whether to generate an outline wherever an input face was cut by a plane.

This is on by default.

◆ GenerateOutlineOn()

virtual void vtkVolumeOutlineSource::GenerateOutlineOn ( )
virtual

◆ GenerateOutlineOff()

virtual void vtkVolumeOutlineSource::GenerateOutlineOff ( )
virtual

◆ GetGenerateOutline()

virtual vtkTypeBool vtkVolumeOutlineSource::GetGenerateOutline ( )
virtual

◆ SetGenerateFaces()

virtual void vtkVolumeOutlineSource::SetGenerateFaces ( vtkTypeBool  )
virtual

Set whether to generate polygonal faces for the output.

By default, only lines are generated. The faces will form a closed, watertight surface.

◆ GenerateFacesOn()

virtual void vtkVolumeOutlineSource::GenerateFacesOn ( )
virtual

◆ GenerateFacesOff()

virtual void vtkVolumeOutlineSource::GenerateFacesOff ( )
virtual

◆ GetGenerateFaces()

virtual vtkTypeBool vtkVolumeOutlineSource::GetGenerateFaces ( )
virtual

◆ SetColor() [1/2]

virtual void vtkVolumeOutlineSource::SetColor ( double  ,
double  ,
double   
)
virtual

Set the color of the outline.

This has no effect unless GenerateScalars is On. The default color is red.

◆ SetColor() [2/2]

virtual void vtkVolumeOutlineSource::SetColor ( double  [3])
virtual

◆ GetColor() [1/3]

virtual double* vtkVolumeOutlineSource::GetColor ( )
virtual

◆ GetColor() [2/3]

virtual void vtkVolumeOutlineSource::GetColor ( double ,
double ,
double  
)
virtual

◆ GetColor() [3/3]

virtual void vtkVolumeOutlineSource::GetColor ( double  [3])
virtual

◆ SetActivePlaneId()

virtual void vtkVolumeOutlineSource::SetActivePlaneId ( int  )
virtual

Set the active plane, e.g.

to display which plane is currently being modified by an interaction. Set this to -1 if there is no active plane. The default value is -1.

◆ GetActivePlaneId()

virtual int vtkVolumeOutlineSource::GetActivePlaneId ( )
virtual

◆ SetActivePlaneColor() [1/2]

virtual void vtkVolumeOutlineSource::SetActivePlaneColor ( double  ,
double  ,
double   
)
virtual

Set the color of the active cropping plane.

This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.

◆ SetActivePlaneColor() [2/2]

virtual void vtkVolumeOutlineSource::SetActivePlaneColor ( double  [3])
virtual

◆ GetActivePlaneColor() [1/3]

virtual double* vtkVolumeOutlineSource::GetActivePlaneColor ( )
virtual

◆ GetActivePlaneColor() [2/3]

virtual void vtkVolumeOutlineSource::GetActivePlaneColor ( double ,
double ,
double  
)
virtual

◆ GetActivePlaneColor() [3/3]

virtual void vtkVolumeOutlineSource::GetActivePlaneColor ( double  [3])
virtual

◆ ComputeCubePlanes()

static int vtkVolumeOutlineSource::ComputeCubePlanes ( double  planes[3][4],
double  croppingPlanes[6],
double  bounds[6] 
)
staticprotected

◆ GeneratePolys()

static void vtkVolumeOutlineSource::GeneratePolys ( vtkCellArray polys,
vtkUnsignedCharArray scalars,
unsigned char  colors[2][3],
int  activePlane,
int  flags,
int  tolPtId[3][4] 
)
staticprotected

◆ GenerateLines()

static void vtkVolumeOutlineSource::GenerateLines ( vtkCellArray lines,
vtkUnsignedCharArray scalars,
unsigned char  colors[2][3],
int  activePlane,
int  flags,
int  tolPtId[3][4] 
)
staticprotected

◆ GeneratePoints()

static void vtkVolumeOutlineSource::GeneratePoints ( vtkPoints points,
vtkCellArray lines,
vtkCellArray polys,
double  planes[3][4],
double  tol 
)
staticprotected

◆ NudgeCropPlanesToBounds()

static void vtkVolumeOutlineSource::NudgeCropPlanesToBounds ( int  tolPtId[3][4],
double  planes[3][4],
double  tol 
)
staticprotected

◆ CreateColorValues()

static void vtkVolumeOutlineSource::CreateColorValues ( unsigned char  colors[2][3],
double  color1[3],
double  color2[3] 
)
staticprotected

◆ ComputePipelineMTime()

int vtkVolumeOutlineSource::ComputePipelineMTime ( vtkInformation request,
vtkInformationVector **  inInfoVec,
vtkInformationVector outInfoVec,
int  requestFromOutputPort,
vtkMTimeType mtime 
)
overrideprotectedvirtual

A special version of ProcessRequest meant specifically for the pipeline modified time request.

See vtkExecutive::ComputePipelineMTime() for details.

Reimplemented from vtkAlgorithm.

◆ RequestInformation()

int vtkVolumeOutlineSource::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

◆ RequestData()

int vtkVolumeOutlineSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

◆ VolumeMapper

vtkVolumeMapper* vtkVolumeOutlineSource::VolumeMapper
protected

Definition at line 121 of file vtkVolumeOutlineSource.h.

◆ GenerateScalars

vtkTypeBool vtkVolumeOutlineSource::GenerateScalars
protected

Definition at line 122 of file vtkVolumeOutlineSource.h.

◆ GenerateOutline

vtkTypeBool vtkVolumeOutlineSource::GenerateOutline
protected

Definition at line 123 of file vtkVolumeOutlineSource.h.

◆ GenerateFaces

vtkTypeBool vtkVolumeOutlineSource::GenerateFaces
protected

Definition at line 124 of file vtkVolumeOutlineSource.h.

◆ ActivePlaneId

int vtkVolumeOutlineSource::ActivePlaneId
protected

Definition at line 125 of file vtkVolumeOutlineSource.h.

◆ Color

double vtkVolumeOutlineSource::Color[3]
protected

Definition at line 126 of file vtkVolumeOutlineSource.h.

◆ ActivePlaneColor

double vtkVolumeOutlineSource::ActivePlaneColor[3]
protected

Definition at line 127 of file vtkVolumeOutlineSource.h.

◆ Cropping

int vtkVolumeOutlineSource::Cropping
protected

Definition at line 129 of file vtkVolumeOutlineSource.h.

◆ CroppingRegionFlags

int vtkVolumeOutlineSource::CroppingRegionFlags
protected

Definition at line 130 of file vtkVolumeOutlineSource.h.

◆ Bounds

double vtkVolumeOutlineSource::Bounds[6]
protected

Definition at line 131 of file vtkVolumeOutlineSource.h.

◆ CroppingRegionPlanes

double vtkVolumeOutlineSource::CroppingRegionPlanes[6]
protected

Definition at line 132 of file vtkVolumeOutlineSource.h.


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