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

represents a volume (data & properties) in a rendered scene More...

#include <vtkVolume.h>

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

Public Types

typedef vtkProp3D Superclass
 
- Public Types inherited from vtkProp3D
typedef vtkProp Superclass
 
- Public Types inherited from vtkProp
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...
 
vtkVolumeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void GetVolumes (vtkPropCollection *vc) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
void Update ()
 Update the volume rendering pipeline by updating the volume mapper. More...
 
vtkMTimeType GetMTime () override
 Return the MTime also considering the property etc. More...
 
vtkMTimeType GetRedrawMTime () override
 Return the mtime of anything that would cause the rendered image to appear differently. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkVolume. More...
 
int RenderVolumetricGeometry (vtkViewport *viewport) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Support the standard render methods. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this volume. More...
 
floatGetCorrectedScalarOpacityArray (int)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
floatGetCorrectedScalarOpacityArray ()
 
floatGetScalarOpacityArray (int)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
floatGetScalarOpacityArray ()
 
floatGetGradientOpacityArray (int)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
floatGetGradientOpacityArray ()
 
floatGetGrayArray (int)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
floatGetGrayArray ()
 
floatGetRGBArray (int)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
floatGetRGBArray ()
 
float GetGradientOpacityConstant (int)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
float GetGradientOpacityConstant ()
 
float GetArraySize ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
void UpdateTransferFunctions (vtkRenderer *ren)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
void UpdateScalarOpacityforSampleSize (vtkRenderer *ren, float sample_distance)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
bool GetSupportsSelection () override
 Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...
 
void SetMapper (vtkAbstractVolumeMapper *mapper)
 Set/Get the volume mapper. More...
 
virtual vtkAbstractVolumeMapperGetMapper ()
 Set/Get the volume mapper. More...
 
virtual void SetProperty (vtkVolumeProperty *property)
 Set/Get the volume property. More...
 
virtual vtkVolumePropertyGetProperty ()
 Set/Get the volume property. More...
 
doubleGetBounds () override
 Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. More...
 
void GetBounds (double bounds[6])
 Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. More...
 
double GetMinXBound ()
 Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. More...
 
double GetMaxXBound ()
 Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. More...
 
double GetMinYBound ()
 Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. More...
 
double GetMaxYBound ()
 Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. More...
 
double GetMinZBound ()
 Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. More...
 
double GetMaxZBound ()
 Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time. More...
 
- Public Member Functions inherited from vtkProp3D
vtkProp3DNewInstance () const
 
virtual void SetPosition (double pos[3])
 
virtual doubleGetPosition ()
 
virtual void GetPosition (double data[3])
 
void AddPosition (double deltaPosition[3])
 
void AddPosition (double deltaX, double deltaY, double deltaZ)
 
void SetScale (double s)
 Method to set the scale isotropically. More...
 
doubleGetCenter ()
 Get the center of the bounding box in world coordinates. More...
 
doubleGetXRange ()
 Get the Prop3D's x range in world coordinates. More...
 
doubleGetYRange ()
 Get the Prop3D's y range in world coordinates. More...
 
doubleGetZRange ()
 Get the Prop3D's z range in world coordinates. More...
 
double GetLength ()
 Get the length of the diagonal of the bounding box. More...
 
void RotateX (double)
 Rotate the Prop3D in degrees about the X axis using the right hand rule. More...
 
void RotateY (double)
 Rotate the Prop3D in degrees about the Y axis using the right hand rule. More...
 
void RotateZ (double)
 Rotate the Prop3D in degrees about the Z axis using the right hand rule. More...
 
void RotateWXYZ (double w, double x, double y, double z)
 Rotate the Prop3D in degrees about an arbitrary axis specified by the last three arguments. More...
 
void SetOrientation (double x, double y, double z)
 Sets the orientation of the Prop3D. More...
 
void SetOrientation (double orientation[3])
 Sets the orientation of the Prop3D. More...
 
doubleGetOrientationWXYZ ()
 Returns the WXYZ orientation of the Prop3D. More...
 
void AddOrientation (double x, double y, double z)
 Add to the current orientation. More...
 
void AddOrientation (double orentation[3])
 Add to the current orientation. More...
 
void PokeMatrix (vtkMatrix4x4 *matrix) override
 This method modifies the vtkProp3D so that its transformation state is set to the matrix specified. More...
 
void InitPathTraversal () override
 Overload vtkProp's method for setting up assembly paths. More...
 
vtkMTimeType GetUserTransformMatrixMTime ()
 Get the modified time of the user matrix or user transform. More...
 
virtual void ComputeMatrix ()
 Generate the matrix based on ivars. More...
 
virtual void SetPosition (double x, double y, double z)
 Set/Get/Add the position of the Prop3D in world coordinates. More...
 
virtual void SetOrigin (double x, double y, double z)
 Set/Get the origin of the Prop3D. More...
 
virtual void SetOrigin (const double pos[3])
 Set/Get the origin of the Prop3D. More...
 
virtual doubleGetOrigin ()
 Set/Get the origin of the Prop3D. More...
 
virtual void GetOrigin (double data[3])
 Set/Get the origin of the Prop3D. More...
 
virtual void SetScale (double x, double y, double z)
 Set/Get the scale of the actor. More...
 
virtual void SetScale (double scale[3])
 Set/Get the scale of the actor. More...
 
virtual doubleGetScale ()
 Set/Get the scale of the actor. More...
 
virtual void GetScale (double data[3])
 Set/Get the scale of the actor. More...
 
void SetUserTransform (vtkLinearTransform *transform)
 In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. More...
 
virtual vtkLinearTransformGetUserTransform ()
 In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. More...
 
void SetUserMatrix (vtkMatrix4x4 *matrix)
 The UserMatrix can be used in place of UserTransform. More...
 
vtkMatrix4x4GetUserMatrix ()
 The UserMatrix can be used in place of UserTransform. More...
 
virtual void GetMatrix (vtkMatrix4x4 *m)
 Return a reference to the Prop3D's 4x4 composite matrix. More...
 
virtual void GetMatrix (double m[16])
 Return a reference to the Prop3D's 4x4 composite matrix. More...
 
void GetBounds (double bounds[6])
 Return a reference to the Prop3D's composite transform. More...
 
doubleGetOrientation ()
 Returns the orientation of the Prop3D as s vector of X,Y and Z rotation. More...
 
void GetOrientation (double orentation[3])
 Returns the orientation of the Prop3D as s vector of X,Y and Z rotation. More...
 
vtkMatrix4x4GetMatrix () override
 Get a pointer to an internal vtkMatrix4x4. More...
 
virtual int GetIsIdentity ()
 Is the matrix for this actor identity. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
virtual void GetActors (vtkPropCollection *)
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
virtual void GetActors2D (vtkPropCollection *)
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderOpaqueGeometry (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. More...
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int RenderOverlay (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys. More...
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys. More...
 
virtual vtkTypeBool HasTranslucentPolygonalGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More...
 
virtual double GetEstimatedRenderTime (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...
 
virtual double GetEstimatedRenderTime ()
 
virtual void SetEstimatedRenderTime (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...
 
virtual void RestoreEstimatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...
 
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...
 
void SetRenderTimeMultiplier (double t)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...
 
virtual double GetRenderTimeMultiplier ()
 
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers More...
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp. More...
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp. More...
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOn ()
 Set/Get the pickable instance variable. More...
 
virtual void PickableOff ()
 Set/Get the pickable instance variable. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable. More...
 
virtual void SetUseBounds (bool)
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual bool GetUseBounds ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual void UseBoundsOn ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual void UseBoundsOff ()
 In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys. More...
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys. More...
 
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers. More...
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,. More...
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,. More...
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property. More...
 
- 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVolumeSafeDownCast (vtkObjectBase *o)
 
static vtkVolumeNew ()
 Creates a Volume with the following defaults: origin(0,0,0) position=(0,0,0) scale=1 visibility=1 pickable=1 dragable=1 orientation=(0,0,0). More...
 
- Static Public Member Functions inherited from vtkProp3D
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkProp3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...
 
static vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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
 
 vtkVolume ()
 
 ~vtkVolume () override
 
double ComputeScreenCoverage (vtkViewport *vp)
 
- Protected Member Functions inherited from vtkProp3D
 vtkProp3D ()
 
 ~vtkProp3D () override
 
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 
 ~vtkProp () override
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkAbstractVolumeMapperMapper
 
vtkVolumePropertyProperty
 
floatRGBArray [VTK_MAX_VRCOMP]
 
vtkTimeStamp RGBArrayMTime [VTK_MAX_VRCOMP]
 
floatGrayArray [VTK_MAX_VRCOMP]
 
vtkTimeStamp GrayArrayMTime [VTK_MAX_VRCOMP]
 
floatScalarOpacityArray [VTK_MAX_VRCOMP]
 
vtkTimeStamp ScalarOpacityArrayMTime [VTK_MAX_VRCOMP]
 
floatCorrectedScalarOpacityArray [VTK_MAX_VRCOMP]
 
vtkTimeStamp CorrectedScalarOpacityArrayMTime [VTK_MAX_VRCOMP]
 
float CorrectedStepSize
 
int ArraySize
 
float GradientOpacityArray [VTK_MAX_VRCOMP][256]
 
float GradientOpacityConstant [VTK_MAX_VRCOMP]
 
vtkTimeStamp GradientOpacityArrayMTime [VTK_MAX_VRCOMP]
 
- Protected Attributes inherited from vtkProp3D
vtkLinearTransformUserTransform
 
vtkMatrix4x4UserMatrix
 
vtkMatrix4x4Matrix
 
vtkTimeStamp MatrixMTime
 
double Origin [3]
 
double Position [3]
 
double Orientation [3]
 
double Scale [3]
 
double Center [3]
 
vtkTransformTransform
 
double Bounds [6]
 
vtkProp3DCachedProp3D
 
int IsIdentity
 
- Protected Attributes inherited from vtkProp
vtkTypeBool Visibility
 
vtkTypeBool Pickable
 
vtkTypeBool Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

represents a volume (data & properties) in a rendered scene

vtkVolume is used to represent a volumetric entity in a rendering scene. It inherits functions related to the volume's position, orientation and origin from vtkProp3D. The volume maintains a reference to the volumetric data (i.e., the volume mapper). The volume also contains a reference to a volume property which contains all common volume rendering parameters.

See also
vtkAbstractVolumeMapper vtkVolumeProperty vtkProp3D
Examples:
vtkVolume (Examples)
Tests:
vtkVolume (Tests)

Definition at line 50 of file vtkVolume.h.

Member Typedef Documentation

Definition at line 53 of file vtkVolume.h.

Constructor & Destructor Documentation

vtkVolume::vtkVolume ( )
protected
vtkVolume::~vtkVolume ( )
overrideprotected

Member Function Documentation

static vtkTypeBool vtkVolume::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkVolume::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 vtkProp3D.

Reimplemented in vtkMultiVolume.

static vtkVolume* vtkVolume::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkVolume::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkProp3D.

Reimplemented in vtkMultiVolume.

vtkVolume* vtkVolume::NewInstance ( ) const
void vtkVolume::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 vtkProp3D.

Reimplemented in vtkMultiVolume.

static vtkVolume* vtkVolume::New ( )
static

Creates a Volume with the following defaults: origin(0,0,0) position=(0,0,0) scale=1 visibility=1 pickable=1 dragable=1 orientation=(0,0,0).

void vtkVolume::SetMapper ( vtkAbstractVolumeMapper mapper)

Set/Get the volume mapper.

virtual vtkAbstractVolumeMapper* vtkVolume::GetMapper ( )
virtual

Set/Get the volume mapper.

virtual void vtkVolume::SetProperty ( vtkVolumeProperty property)
virtual

Set/Get the volume property.

Reimplemented in vtkMultiVolume.

virtual vtkVolumeProperty* vtkVolume::GetProperty ( )
virtual

Set/Get the volume property.

Reimplemented in vtkMultiVolume.

void vtkVolume::GetVolumes ( vtkPropCollection vc)
overridevirtual

For some exporters and other other operations we must be able to collect all the actors or volumes.

This method is used in that process.

Reimplemented from vtkProp.

void vtkVolume::Update ( )

Update the volume rendering pipeline by updating the volume mapper.

double* vtkVolume::GetBounds ( )
overridevirtual

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

Implements vtkProp3D.

Reimplemented in vtkMultiVolume.

void vtkVolume::GetBounds ( double  bounds[6])
inline

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

Definition at line 97 of file vtkVolume.h.

double vtkVolume::GetMinXBound ( )

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

double vtkVolume::GetMaxXBound ( )

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

double vtkVolume::GetMinYBound ( )

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

double vtkVolume::GetMaxYBound ( )

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

double vtkVolume::GetMinZBound ( )

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

double vtkVolume::GetMaxZBound ( )

Get the bounds - either all six at once (xmin, xmax, ymin, ymax, zmin, zmax) or one at a time.

vtkMTimeType vtkVolume::GetMTime ( )
overridevirtual

Return the MTime also considering the property etc.

Reimplemented from vtkProp3D.

Reimplemented in vtkMultiVolume.

vtkMTimeType vtkVolume::GetRedrawMTime ( )
overridevirtual

Return the mtime of anything that would cause the rendered image to appear differently.

Usually this involves checking the mtime of the prop plus anything else it depends on such as properties, mappers, etc.

Reimplemented from vtkProp.

void vtkVolume::ShallowCopy ( vtkProp prop)
overridevirtual

Shallow copy of this vtkVolume.

Overloads the virtual vtkProp method.

Reimplemented from vtkProp3D.

Reimplemented in vtkMultiVolume.

int vtkVolume::RenderVolumetricGeometry ( vtkViewport viewport)
overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Support the standard render methods.

Depending on the mapper type, the volume may be rendered using this method (FRAMEBUFFER volume such as texture mapping will be rendered this way)

Reimplemented from vtkProp.

Reimplemented in vtkMultiVolume.

void vtkVolume::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this volume.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

float* vtkVolume::GetCorrectedScalarOpacityArray ( int  )

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

float* vtkVolume::GetCorrectedScalarOpacityArray ( )
inline

Definition at line 148 of file vtkVolume.h.

float* vtkVolume::GetScalarOpacityArray ( int  )

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

float* vtkVolume::GetScalarOpacityArray ( )
inline

Definition at line 156 of file vtkVolume.h.

float* vtkVolume::GetGradientOpacityArray ( int  )

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

float* vtkVolume::GetGradientOpacityArray ( )
inline

Definition at line 164 of file vtkVolume.h.

float* vtkVolume::GetGrayArray ( int  )

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

float* vtkVolume::GetGrayArray ( )
inline

Definition at line 172 of file vtkVolume.h.

float* vtkVolume::GetRGBArray ( int  )

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

float* vtkVolume::GetRGBArray ( )
inline

Definition at line 180 of file vtkVolume.h.

float vtkVolume::GetGradientOpacityConstant ( int  )

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

float vtkVolume::GetGradientOpacityConstant ( )
inline

Definition at line 188 of file vtkVolume.h.

float vtkVolume::GetArraySize ( )
inline

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

Definition at line 195 of file vtkVolume.h.

void vtkVolume::UpdateTransferFunctions ( vtkRenderer ren)

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

void vtkVolume::UpdateScalarOpacityforSampleSize ( vtkRenderer ren,
float  sample_distance 
)

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

bool vtkVolume::GetSupportsSelection ( )
inlineoverridevirtual

Used by vtkHardwareSelector to determine if the prop supports hardware selection.

Warning
INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS

Reimplemented from vtkProp.

Definition at line 218 of file vtkVolume.h.

double vtkVolume::ComputeScreenCoverage ( vtkViewport vp)
protected

Member Data Documentation

vtkAbstractVolumeMapper* vtkVolume::Mapper
protected

Definition at line 225 of file vtkVolume.h.

vtkVolumeProperty* vtkVolume::Property
protected

Definition at line 226 of file vtkVolume.h.

float* vtkVolume::RGBArray[VTK_MAX_VRCOMP]
protected

Definition at line 232 of file vtkVolume.h.

vtkTimeStamp vtkVolume::RGBArrayMTime[VTK_MAX_VRCOMP]
protected

Definition at line 233 of file vtkVolume.h.

float* vtkVolume::GrayArray[VTK_MAX_VRCOMP]
protected

Definition at line 239 of file vtkVolume.h.

vtkTimeStamp vtkVolume::GrayArrayMTime[VTK_MAX_VRCOMP]
protected

Definition at line 240 of file vtkVolume.h.

float* vtkVolume::ScalarOpacityArray[VTK_MAX_VRCOMP]
protected

Definition at line 246 of file vtkVolume.h.

vtkTimeStamp vtkVolume::ScalarOpacityArrayMTime[VTK_MAX_VRCOMP]
protected

Definition at line 247 of file vtkVolume.h.

float* vtkVolume::CorrectedScalarOpacityArray[VTK_MAX_VRCOMP]
protected

Definition at line 253 of file vtkVolume.h.

vtkTimeStamp vtkVolume::CorrectedScalarOpacityArrayMTime[VTK_MAX_VRCOMP]
protected

Definition at line 254 of file vtkVolume.h.

float vtkVolume::CorrectedStepSize
protected

Definition at line 260 of file vtkVolume.h.

int vtkVolume::ArraySize
protected

Definition at line 263 of file vtkVolume.h.

float vtkVolume::GradientOpacityArray[VTK_MAX_VRCOMP][256]
protected

Definition at line 266 of file vtkVolume.h.

float vtkVolume::GradientOpacityConstant[VTK_MAX_VRCOMP]
protected

Definition at line 267 of file vtkVolume.h.

vtkTimeStamp vtkVolume::GradientOpacityArrayMTime[VTK_MAX_VRCOMP]
protected

Definition at line 268 of file vtkVolume.h.


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