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

draw an image in a rendered 3D scene More...

#include <vtkImageActor.h>

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

Public Types

typedef vtkImageSlice Superclass
 
- Public Types inherited from vtkImageSlice
typedef vtkProp3D Superclass
 
- Public Types inherited from vtkProp3D
typedef vtkProp Superclass
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImageActorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int HasTranslucentPolygonalGeometry () override
 Internal method, should only be used by rendering. More...
 
virtual void SetInputData (vtkImageData *)
 Set/Get the image data input for the image actor. More...
 
virtual vtkImageDataGetInput ()
 Set/Get the image data input for the image actor. More...
 
virtual void SetInterpolate (int)
 Turn on/off linear interpolation of the image when rendering. More...
 
virtual int GetInterpolate ()
 Turn on/off linear interpolation of the image when rendering. More...
 
virtual void InterpolateOn ()
 Turn on/off linear interpolation of the image when rendering. More...
 
virtual void InterpolateOff ()
 Turn on/off linear interpolation of the image when rendering. More...
 
virtual void SetOpacity (double)
 Set/Get the object's opacity. More...
 
virtual double GetOpacity ()
 Set/Get the object's opacity. More...
 
double GetOpacityMinValue ()
 Set/Get the object's opacity. More...
 
double GetOpacityMaxValue ()
 Set/Get the object's opacity. More...
 
void SetDisplayExtent (int extent[6])
 The image extent is generally set explicitly, but if not set it will be determined from the input image data. More...
 
void SetDisplayExtent (int minX, int maxX, int minY, int maxY, int minZ, int maxZ)
 The image extent is generally set explicitly, but if not set it will be determined from the input image data. More...
 
void GetDisplayExtent (int extent[6])
 The image extent is generally set explicitly, but if not set it will be determined from the input image data. More...
 
intGetDisplayExtent ()
 The image extent is generally set explicitly, but if not set it will be determined from the input image data. More...
 
doubleGetBounds () override
 Get the bounds of this image actor. More...
 
void GetBounds (double bounds[6])
 Get the bounds of this image actor. More...
 
doubleGetDisplayBounds ()
 Get the bounds of the data that is displayed by this image actor. More...
 
void GetDisplayBounds (double bounds[6])
 Get the bounds of the data that is displayed by this image actor. More...
 
int GetSliceNumber ()
 Return the slice number (& min/max slice number) computed from the display extent. More...
 
int GetSliceNumberMax ()
 Return the slice number (& min/max slice number) computed from the display extent. More...
 
int GetSliceNumberMin ()
 Return the slice number (& min/max slice number) computed from the display extent. More...
 
void SetZSlice (int z)
 Set/Get the current slice number. More...
 
int GetZSlice ()
 Set/Get the current slice number. More...
 
int GetWholeZMin ()
 Set/Get the current slice number. More...
 
int GetWholeZMax ()
 Set/Get the current slice number. More...
 
virtual bool GetForceOpaque ()
 Force the actor to be rendered during the opaque rendering pass. More...
 
virtual void SetForceOpaque (bool)
 Force the actor to be rendered during the opaque rendering pass. More...
 
virtual void ForceOpaqueOn ()
 Force the actor to be rendered during the opaque rendering pass. More...
 
virtual void ForceOpaqueOff ()
 Force the actor to be rendered during the opaque rendering pass. More...
 
- Public Member Functions inherited from vtkImageSlice
vtkImageSliceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Update ()
 Update the rendering pipeline by updating the ImageMapper. 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 vtkImageSlice. More...
 
void GetImages (vtkPropCollection *)
 For some exporters and other other operations we must be able to collect all the actors, volumes, and images. More...
 
int HasTranslucentPolygonalGeometry () override
 Internal method, should only be used by rendering. More...
 
virtual void Render (vtkRenderer *)
 This causes the image and its mapper to be rendered. More...
 
void ReleaseGraphicsResources (vtkWindow *win) override
 Release any resources held by this prop. More...
 
void SetStackedImagePass (int pass)
 For stacked image rendering, set the pass. More...
 
void SetMapper (vtkImageMapper3D *mapper)
 Set/Get the mapper. More...
 
virtual vtkImageMapper3DGetMapper ()
 Set/Get the mapper. More...
 
void SetProperty (vtkImageProperty *property)
 Set/Get the image display properties. More...
 
virtual vtkImagePropertyGetProperty ()
 Set/Get the image display properties. 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...
 
virtual bool GetForceTranslucent ()
 Force the actor to be treated as translucent. More...
 
virtual void SetForceTranslucent (bool)
 Force the actor to be treated as translucent. More...
 
virtual void ForceTranslucentOn ()
 Force the actor to be treated as translucent. More...
 
virtual void ForceTranslucentOff ()
 Force the actor to be treated as translucent. More...
 
int RenderOverlay (vtkViewport *viewport) override
 Support the standard render methods. More...
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Support the standard render methods. More...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 Support the standard render methods. More...
 
- Public Member Functions inherited from vtkProp3D
vtkProp3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp3D. More...
 
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 GetMTime () override
 Get the vtkProp3D's mtime. 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 GetVolumes (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 RenderVolumetricGeometry (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 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 bool GetSupportsSelection ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...
 
virtual void SetVisibility (int)
 Set/Get visibility of this vtkProp. More...
 
virtual int 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 (int)
 Set/Get the pickable instance variable. More...
 
virtual int 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 (int)
 Set/Get the value of the dragable instance variable. More...
 
virtual int 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...
 
- 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 ()
 
int HasObserver (unsigned long event)
 
int 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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 int IsTypeOf (const char *type)
 
static vtkImageActorSafeDownCast (vtkObjectBase *o)
 
static vtkImageActorNew ()
 Instantiate the image actor. More...
 
- Static Public Member Functions inherited from vtkImageSlice
static int IsTypeOf (const char *type)
 
static vtkImageSliceSafeDownCast (vtkObjectBase *o)
 
static vtkImageSliceNew ()
 Creates an Image 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 int IsTypeOf (const char *type)
 
static vtkProp3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp
static int 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
 
 vtkImageActor ()
 
 ~vtkImageActor () override
 
vtkAlgorithmGetInputAlgorithm ()
 
- Protected Member Functions inherited from vtkImageSlice
 vtkImageSlice ()
 
 ~vtkImageSlice () override
 
- 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 &)
 

Static Protected Member Functions

static int GetOrientationFromExtent (const int extent[6])
 Guess the orientation from the extent. More...
 

Protected Attributes

int DisplayExtent [6]
 
double DisplayBounds [6]
 
vtkTimeStamp TranslucentComputationTime
 
int TranslucentCachedResult
 
bool ForceOpaque
 
- Protected Attributes inherited from vtkImageSlice
vtkImageMapper3DMapper
 
vtkImagePropertyProperty
 
bool ForceTranslucent
 
- 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
int Visibility
 
int Pickable
 
int Dragable
 
bool UseBounds
 
double AllocatedRenderTime
 
double EstimatedRenderTime
 
double SavedEstimatedRenderTime
 
double RenderTimeMultiplier
 
int NumberOfConsumers
 
vtkObject ** Consumers
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

draw an image in a rendered 3D scene

vtkImageActor is used to render an image in a 3D scene. The image is placed at the origin of the image, and its size is controlled by the image dimensions and image spacing. The orientation of the image is orthogonal to one of the x-y-z axes depending on which plane the image is defined in. This class has been mostly superseded by the vtkImageSlice class, which provides more functionality than vtkImageActor.

See also
vtkImageData vtkImageSliceMapper vtkImageProperty
Examples:
vtkImageActor (Examples)
Tests:
vtkImageActor (Tests)

Definition at line 49 of file vtkImageActor.h.

Member Typedef Documentation

Definition at line 52 of file vtkImageActor.h.

Constructor & Destructor Documentation

vtkImageActor::vtkImageActor ( )
protected
vtkImageActor::~vtkImageActor ( )
overrideprotected

Member Function Documentation

static int vtkImageActor::IsTypeOf ( const char *  type)
static
virtual int vtkImageActor::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 vtkImageSlice.

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

Reimplemented from vtkImageSlice.

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

static vtkImageActor* vtkImageActor::New ( )
static

Instantiate the image actor.

virtual void vtkImageActor::SetInputData ( vtkImageData )
virtual

Set/Get the image data input for the image actor.

This is for backwards compatibility, for a proper pipeline connection you should use GetMapper()->SetInputConnection() instead.

virtual vtkImageData* vtkImageActor::GetInput ( )
virtual

Set/Get the image data input for the image actor.

This is for backwards compatibility, for a proper pipeline connection you should use GetMapper()->SetInputConnection() instead.

virtual void vtkImageActor::SetInterpolate ( int  )
virtual

Turn on/off linear interpolation of the image when rendering.

More options are available in the Property of the image actor.

virtual int vtkImageActor::GetInterpolate ( )
virtual

Turn on/off linear interpolation of the image when rendering.

More options are available in the Property of the image actor.

virtual void vtkImageActor::InterpolateOn ( )
virtual

Turn on/off linear interpolation of the image when rendering.

More options are available in the Property of the image actor.

virtual void vtkImageActor::InterpolateOff ( )
virtual

Turn on/off linear interpolation of the image when rendering.

More options are available in the Property of the image actor.

virtual void vtkImageActor::SetOpacity ( double  )
virtual

Set/Get the object's opacity.

1.0 is totally opaque and 0.0 is completely transparent. The default is 1.0.

virtual double vtkImageActor::GetOpacity ( )
virtual

Set/Get the object's opacity.

1.0 is totally opaque and 0.0 is completely transparent. The default is 1.0.

double vtkImageActor::GetOpacityMinValue ( )
inline

Set/Get the object's opacity.

1.0 is totally opaque and 0.0 is completely transparent. The default is 1.0.

Definition at line 87 of file vtkImageActor.h.

double vtkImageActor::GetOpacityMaxValue ( )
inline

Set/Get the object's opacity.

1.0 is totally opaque and 0.0 is completely transparent. The default is 1.0.

Definition at line 88 of file vtkImageActor.h.

void vtkImageActor::SetDisplayExtent ( int  extent[6])

The image extent is generally set explicitly, but if not set it will be determined from the input image data.

void vtkImageActor::SetDisplayExtent ( int  minX,
int  maxX,
int  minY,
int  maxY,
int  minZ,
int  maxZ 
)

The image extent is generally set explicitly, but if not set it will be determined from the input image data.

void vtkImageActor::GetDisplayExtent ( int  extent[6])

The image extent is generally set explicitly, but if not set it will be determined from the input image data.

int* vtkImageActor::GetDisplayExtent ( )
inline

The image extent is generally set explicitly, but if not set it will be determined from the input image data.

Definition at line 100 of file vtkImageActor.h.

double* vtkImageActor::GetBounds ( )
overridevirtual

Get the bounds of this image actor.

Either copy the bounds into a user provided array or return a pointer to an array. In either case the bounds is expressed as a 6-vector (xmin,xmax, ymin,ymax, zmin,zmax).

Implements vtkProp3D.

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

Get the bounds of this image actor.

Either copy the bounds into a user provided array or return a pointer to an array. In either case the bounds is expressed as a 6-vector (xmin,xmax, ymin,ymax, zmin,zmax).

Definition at line 111 of file vtkImageActor.h.

double* vtkImageActor::GetDisplayBounds ( )

Get the bounds of the data that is displayed by this image actor.

If the transformation matrix for this actor is the identity matrix, this will return the same value as GetBounds.

void vtkImageActor::GetDisplayBounds ( double  bounds[6])

Get the bounds of the data that is displayed by this image actor.

If the transformation matrix for this actor is the identity matrix, this will return the same value as GetBounds.

int vtkImageActor::GetSliceNumber ( )

Return the slice number (& min/max slice number) computed from the display extent.

int vtkImageActor::GetSliceNumberMax ( )

Return the slice number (& min/max slice number) computed from the display extent.

int vtkImageActor::GetSliceNumberMin ( )

Return the slice number (& min/max slice number) computed from the display extent.

void vtkImageActor::SetZSlice ( int  z)
inline

Set/Get the current slice number.

The axis Z in ZSlice does not necessarily have any relation to the z axis of the data on disk. It is simply the axis orthogonal to the x,y, display plane. GetWholeZMax and Min are convenience methods for obtaining the number of slices that can be displayed. Again the number of slices is in reference to the display z axis, which is not necessarily the z axis on disk. (due to reformatting etc)

Definition at line 145 of file vtkImageActor.h.

int vtkImageActor::GetZSlice ( )
inline

Set/Get the current slice number.

The axis Z in ZSlice does not necessarily have any relation to the z axis of the data on disk. It is simply the axis orthogonal to the x,y, display plane. GetWholeZMax and Min are convenience methods for obtaining the number of slices that can be displayed. Again the number of slices is in reference to the display z axis, which is not necessarily the z axis on disk. (due to reformatting etc)

Definition at line 149 of file vtkImageActor.h.

int vtkImageActor::GetWholeZMin ( )

Set/Get the current slice number.

The axis Z in ZSlice does not necessarily have any relation to the z axis of the data on disk. It is simply the axis orthogonal to the x,y, display plane. GetWholeZMax and Min are convenience methods for obtaining the number of slices that can be displayed. Again the number of slices is in reference to the display z axis, which is not necessarily the z axis on disk. (due to reformatting etc)

int vtkImageActor::GetWholeZMax ( )

Set/Get the current slice number.

The axis Z in ZSlice does not necessarily have any relation to the z axis of the data on disk. It is simply the axis orthogonal to the x,y, display plane. GetWholeZMax and Min are convenience methods for obtaining the number of slices that can be displayed. Again the number of slices is in reference to the display z axis, which is not necessarily the z axis on disk. (due to reformatting etc)

int vtkImageActor::HasTranslucentPolygonalGeometry ( )
overridevirtual

Internal method, should only be used by rendering.

Returns true if this image actor has an alpha component or if it has an opacity that is less than 1.0. This can be overridden by ForceOpaqueOn(), which forces this method to return false, or ForceTranslucentOn(), which forces this method to return true.

Reimplemented from vtkProp.

virtual bool vtkImageActor::GetForceOpaque ( )
virtual

Force the actor to be rendered during the opaque rendering pass.

Default is false. See also: ForceTranslucentOn() to use translucent rendering pass.

virtual void vtkImageActor::SetForceOpaque ( bool  )
virtual

Force the actor to be rendered during the opaque rendering pass.

Default is false. See also: ForceTranslucentOn() to use translucent rendering pass.

virtual void vtkImageActor::ForceOpaqueOn ( )
virtual

Force the actor to be rendered during the opaque rendering pass.

Default is false. See also: ForceTranslucentOn() to use translucent rendering pass.

virtual void vtkImageActor::ForceOpaqueOff ( )
virtual

Force the actor to be rendered during the opaque rendering pass.

Default is false. See also: ForceTranslucentOn() to use translucent rendering pass.

static int vtkImageActor::GetOrientationFromExtent ( const int  extent[6])
staticprotected

Guess the orientation from the extent.

The orientation will be Z unless the extent is single-slice in one of the other directions.

vtkAlgorithm* vtkImageActor::GetInputAlgorithm ( )
protected

Member Data Documentation

int vtkImageActor::DisplayExtent[6]
protected

Definition at line 184 of file vtkImageActor.h.

double vtkImageActor::DisplayBounds[6]
protected

Definition at line 185 of file vtkImageActor.h.

vtkTimeStamp vtkImageActor::TranslucentComputationTime
protected

Definition at line 191 of file vtkImageActor.h.

int vtkImageActor::TranslucentCachedResult
protected

Definition at line 192 of file vtkImageActor.h.

bool vtkImageActor::ForceOpaque
protected

Definition at line 193 of file vtkImageActor.h.


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