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

represents an object (geometry & properties) in a rendered scene More...

#include <vtkActor.h>

Inheritance diagram for vtkActor:
[legend]
Collaboration diagram for vtkActor:
[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.
 
vtkActorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes.
 
virtual void Render (vtkRenderer *, vtkMapper *)
 This causes the actor to be rendered.
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of an actor.
 
void ReleaseGraphicsResources (vtkWindow *) override
 Release any graphics resources that are being consumed by this actor.
 
virtual vtkPropertyMakeProperty ()
 Create a new property suitable for use with this type of Actor.
 
virtual void SetMapper (vtkMapper *)
 This is the method that is used to connect an actor to the end of a visualization pipeline, i.e.
 
double * GetBounds () override
 Return a reference to the Prop3D's composite transform.
 
virtual void ApplyProperties ()
 Apply the current properties to all parts that compose this actor.
 
vtkMTimeType GetMTime () override
 Get the actors mtime plus consider its properties and texture if set.
 
vtkMTimeType GetRedrawMTime () override
 Return the mtime of anything that would cause the rendered image to appear differently.
 
bool GetSupportsSelection () override
 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.
 
void ProcessSelectorPixelBuffers (vtkHardwareSelector *sel, std::vector< unsigned int > &pixeloffsets) override
 allows a prop to update a selections color buffers Default just forwards to the Mapper
 
void GetBounds (double bounds[6])
 Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
 
double * GetBounds () override=0
 Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 Support the standard render methods.
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 Support the standard render methods.
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 Does this prop have some opaque/translucent polygonal geometry?
 
vtkTypeBool HasOpaqueGeometry () override
 Does this prop have some opaque/translucent polygonal geometry?
 
void SetProperty (vtkProperty *lut)
 Set/Get the property object that controls this actors surface properties.
 
vtkPropertyGetProperty ()
 Set/Get the property object that controls this actors surface properties.
 
void SetBackfaceProperty (vtkProperty *lut)
 Set/Get the property object that controls this actors backface surface properties.
 
virtual vtkPropertyGetBackfaceProperty ()
 Set/Get the property object that controls this actors backface surface properties.
 
virtual void SetTexture (vtkTexture *)
 Set/Get the texture object to control rendering texture maps.
 
virtual vtkTextureGetTexture ()
 Set/Get the texture object to control rendering texture maps.
 
virtual vtkMapperGetMapper ()
 Returns the Mapper that this actor is getting its data from.
 
virtual bool GetForceOpaque ()
 Force the actor to be treated as opaque or translucent.
 
virtual void SetForceOpaque (bool)
 Force the actor to be treated as opaque or translucent.
 
virtual void ForceOpaqueOn ()
 Force the actor to be treated as opaque or translucent.
 
virtual void ForceOpaqueOff ()
 Force the actor to be treated as opaque or translucent.
 
virtual bool GetForceTranslucent ()
 Force the actor to be treated as opaque or translucent.
 
virtual void SetForceTranslucent (bool)
 Force the actor to be treated as opaque or translucent.
 
virtual void ForceTranslucentOn ()
 Force the actor to be treated as opaque or translucent.
 
virtual void ForceTranslucentOff ()
 Force the actor to be treated as opaque or translucent.
 
bool IsRenderingTranslucentPolygonalGeometry () override
 
void SetIsRenderingTranslucentPolygonalGeometry (bool val)
 
- Public Member Functions inherited from vtkProp3D
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkProp3DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp3D.
 
virtual void SetPosition (double pos[3])
 
virtual double * GetPosition ()
 
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.
 
double * GetCenter ()
 Get the center of the bounding box in world coordinates.
 
double * GetXRange ()
 Get the Prop3D's x range in world coordinates.
 
double * GetYRange ()
 Get the Prop3D's y range in world coordinates.
 
double * GetZRange ()
 Get the Prop3D's z range in world coordinates.
 
double GetLength ()
 Get the length of the diagonal of the bounding box.
 
void RotateX (double)
 Rotate the Prop3D in degrees about the X axis using the right hand rule.
 
void RotateY (double)
 Rotate the Prop3D in degrees about the Y axis using the right hand rule.
 
void RotateZ (double)
 Rotate the Prop3D in degrees about the Z axis using the right hand rule.
 
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.
 
void SetOrientation (double x, double y, double z)
 Sets the orientation of the Prop3D.
 
void SetOrientation (double orientation[3])
 Sets the orientation of the Prop3D.
 
double * GetOrientationWXYZ ()
 Returns the WXYZ orientation of the Prop3D.
 
void AddOrientation (double x, double y, double z)
 Add to the current orientation.
 
void AddOrientation (double orentation[3])
 Add to the current orientation.
 
void PokeMatrix (vtkMatrix4x4 *matrix) override
 This method modifies the vtkProp3D so that its transformation state is set to the matrix specified.
 
void InitPathTraversal () override
 Overload vtkProp's method for setting up assembly paths.
 
vtkMTimeType GetMTime () override
 Get the vtkProp3D's mtime.
 
vtkMTimeType GetUserTransformMatrixMTime ()
 Get the modified time of the user matrix or user transform.
 
virtual void ComputeMatrix ()
 Generate the matrix based on ivars.
 
virtual void SetPosition (double x, double y, double z)
 Set/Get/Add the position of the Prop3D in world coordinates.
 
virtual void SetOrigin (double x, double y, double z)
 Set/Get the origin of the Prop3D.
 
virtual void SetOrigin (const double pos[3])
 Set/Get the origin of the Prop3D.
 
virtual double * GetOrigin ()
 Set/Get the origin of the Prop3D.
 
virtual void GetOrigin (double data[3])
 Set/Get the origin of the Prop3D.
 
virtual void SetScale (double x, double y, double z)
 Set/Get the scale of the actor.
 
virtual void SetScale (double scale[3])
 Set/Get the scale of the actor.
 
virtual double * GetScale ()
 Set/Get the scale of the actor.
 
virtual void GetScale (double data[3])
 Set/Get the scale of the actor.
 
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.
 
virtual vtkLinearTransformGetUserTransform ()
 In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.
 
void SetUserMatrix (vtkMatrix4x4 *matrix)
 The UserMatrix can be used in place of UserTransform.
 
vtkMatrix4x4GetUserMatrix ()
 The UserMatrix can be used in place of UserTransform.
 
virtual void GetMatrix (vtkMatrix4x4 *result)
 Return a reference to the Prop3D's 4x4 composite matrix.
 
virtual void GetMatrix (double result[16])
 Return a reference to the Prop3D's 4x4 composite matrix.
 
void GetBounds (double bounds[6])
 Return a reference to the Prop3D's composite transform.
 
double * GetOrientation ()
 Returns the orientation of the Prop3D as s vector of X,Y and Z rotation.
 
void GetOrientation (double orentation[3])
 Returns the orientation of the Prop3D as s vector of X,Y and Z rotation.
 
vtkMatrix4x4GetMatrix () override
 Get a pointer to an internal vtkMatrix4x4.
 
virtual int GetIsIdentity ()
 Is the matrix for this actor identity.
 
- Public Member Functions inherited from vtkProp
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void GetActors (vtkPropCollection *)
 For some exporters and other other operations we must be able to collect all the actors or volumes.
 
virtual void GetActors2D (vtkPropCollection *)
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked.
 
virtual vtkMTimeType GetRedrawMTime ()
 Return the mtime of anything that would cause the rendered image to appear differently.
 
virtual double * GetBounds ()
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
 
virtual void ShallowCopy (vtkProp *prop)
 Shallow copy of this vtkProp.
 
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
 These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
 
virtual vtkMatrix4x4GetMatrix ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys.
 
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.
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual int RenderOverlay (vtkViewport *)
 
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the opaque geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the translucent polygonal geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
 Render the volumetric geometry only if the prop has all the requiredKeys.
 
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
 Render in the overlay of the viewport only if the prop has all the requiredKeys.
 
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.
 
virtual vtkTypeBool HasOpaqueGeometry ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
virtual void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp.
 
virtual vtkTypeBool GetVisibility ()
 Set/Get visibility of this vtkProp.
 
virtual void VisibilityOn ()
 Set/Get visibility of this vtkProp.
 
virtual void VisibilityOff ()
 Set/Get visibility of this vtkProp.
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable.
 
virtual vtkTypeBool GetPickable ()
 Set/Get the pickable instance variable.
 
virtual void PickableOn ()
 Set/Get the pickable instance variable.
 
virtual void PickableOff ()
 Set/Get the pickable instance variable.
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable.
 
virtual vtkTypeBool GetDragable ()
 Set/Get the value of the dragable instance variable.
 
virtual void DragableOn ()
 Set/Get the value of the dragable instance variable.
 
virtual void DragableOff ()
 Set/Get the value of the dragable instance variable.
 
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().
 
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().
 
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().
 
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().
 
virtual vtkAssemblyPathGetNextPath ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
 
virtual int GetNumberOfPaths ()
 vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
 
virtual vtkInformationGetPropertyKeys ()
 Set/Get property keys.
 
virtual void SetPropertyKeys (vtkInformation *keys)
 Set/Get property keys.
 
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.
 
virtual double GetAllocatedRenderTime ()
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
 
virtual int GetNumberOfConsumers ()
 Get the number of consumers.
 
void AddConsumer (vtkObject *c)
 Add or remove or get or check a consumer,.
 
void RemoveConsumer (vtkObject *c)
 Add or remove or get or check a consumer,.
 
vtkObjectGetConsumer (int i)
 Add or remove or get or check a consumer,.
 
int IsConsumer (vtkObject *c)
 Add or remove or get or check a consumer,.
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property.
 
virtual vtkShaderPropertyGetShaderProperty ()
 Set/Get the shader property.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkActorSafeDownCast (vtkObjectBase *o)
 
static vtkActorNew ()
 Creates an actor with the following defaults: origin(0,0,0) position=(0,0,0) scale=(1,1,1) visibility=1 pickable=1 dragable=1 orientation=(0,0,0).
 
- 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.
 
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.
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkActor ()
 
 ~vtkActor () override
 
int GetIsOpaque ()
 
- Protected Member Functions inherited from vtkProp3D
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkProp3D ()
 
 ~vtkProp3D () override
 
- Protected Member Functions inherited from vtkProp
virtual vtkObjectBaseNewInstanceInternal () const
 
 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

bool ForceOpaque
 
bool ForceTranslucent
 
bool InTranslucentPass
 
vtkPropertyProperty
 
vtkPropertyBackfaceProperty
 
vtkTextureTexture
 
vtkMapperMapper
 
double MapperBounds [6]
 
vtkTimeStamp BoundsMTime
 
- 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

represents an object (geometry & properties) in a rendered scene

vtkActor is used to represent an entity in a rendering scene. It inherits functions related to the actors position, and orientation from vtkProp. The actor also has scaling and maintains a reference to the defining geometry (i.e., the mapper), rendering properties, and possibly a texture map. vtkActor combines these instance variables into one 4x4 transformation matrix as follows: [x y z 1] = [x y z 1] Translate(-origin) Scale(scale) Rot(y) Rot(x) Rot (z) Trans(origin) Trans(position)

See also
vtkProperty vtkTexture vtkMapper vtkAssembly vtkFollower vtkLODActor
Online Examples:

Definition at line 154 of file vtkActor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 157 of file vtkActor.h.

Constructor & Destructor Documentation

◆ vtkActor()

vtkActor::vtkActor ( )
protected

◆ ~vtkActor()

vtkActor::~vtkActor ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkActor::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 vtkAxisActor, vtkAxisFollower, vtkCubeAxesActor, vtkPolarAxesActor, vtkAvatar, vtkFlagpoleLabel, vtkFollower, vtkSkybox, vtkOpenGLMovieSphere, vtkLODActor, vtkQuadricLODActor, vtkOpenGLActor, vtkOpenGLSkybox, vtkOpenGLAvatar, and vtkVRFollower.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkActor::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkActor * vtkActor::NewInstance ( ) const

◆ PrintSelf()

void vtkActor::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.

Reimplemented in vtkAvatar, vtkFlagpoleLabel, vtkFollower, vtkSkybox, vtkOpenGLMovieSphere, vtkLODActor, vtkQuadricLODActor, vtkOpenGLActor, vtkOpenGLSkybox, vtkOpenGLAvatar, and vtkVRFollower.

◆ New()

static vtkActor * vtkActor::New ( )
static

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

No user defined matrix and no texture map.

◆ GetActors()

void vtkActor::GetActors ( vtkPropCollection )
overridevirtual

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

These methods are used in that process.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkActor::RenderOpaqueGeometry ( vtkViewport viewport)
overridevirtual

Support the standard render methods.

Reimplemented from vtkProp.

Reimplemented in vtkFollower, vtkFlagpoleLabel, and vtkOpenGLAvatar.

◆ RenderTranslucentPolygonalGeometry()

int vtkActor::RenderTranslucentPolygonalGeometry ( vtkViewport viewport)
overridevirtual

Support the standard render methods.

Reimplemented from vtkProp.

Reimplemented in vtkFollower, vtkFlagpoleLabel, and vtkOpenGLAvatar.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkActor::HasTranslucentPolygonalGeometry ( )
overridevirtual

Does this prop have some opaque/translucent polygonal geometry?

Reimplemented from vtkProp.

Reimplemented in vtkFlagpoleLabel.

◆ HasOpaqueGeometry()

vtkTypeBool vtkActor::HasOpaqueGeometry ( )
overridevirtual

Does this prop have some opaque/translucent polygonal geometry?

Reimplemented from vtkProp.

◆ Render()

virtual void vtkActor::Render ( vtkRenderer ,
vtkMapper  
)
inlinevirtual

This causes the actor to be rendered.

It in turn will render the actor's property, texture map and then mapper. If a property hasn't been assigned, then the actor will create one automatically. Note that a side effect of this method is that the pipeline will be updated.

Reimplemented in vtkLODActor, vtkQuadricLODActor, vtkOpenGLMovieSphere, vtkOpenGLActor, and vtkOpenGLSkybox.

Definition at line 196 of file vtkActor.h.

◆ ShallowCopy()

void vtkActor::ShallowCopy ( vtkProp prop)
overridevirtual

Shallow copy of an actor.

Overloads the virtual vtkProp method.

Reimplemented from vtkProp.

Reimplemented in vtkFollower, vtkLODActor, and vtkQuadricLODActor.

◆ ReleaseGraphicsResources()

void vtkActor::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

Release any graphics resources that are being consumed by this actor.

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

Reimplemented from vtkProp.

Reimplemented in vtkFollower, vtkLODActor, vtkQuadricLODActor, and vtkFlagpoleLabel.

◆ SetProperty()

void vtkActor::SetProperty ( vtkProperty lut)

Set/Get the property object that controls this actors surface properties.

This should be an instance of a vtkProperty object. Every actor must have a property associated with it. If one isn't specified, then one will be generated automatically. Multiple actors can share one property object.

◆ GetProperty()

vtkProperty * vtkActor::GetProperty ( )

Set/Get the property object that controls this actors surface properties.

This should be an instance of a vtkProperty object. Every actor must have a property associated with it. If one isn't specified, then one will be generated automatically. Multiple actors can share one property object.

◆ MakeProperty()

virtual vtkProperty * vtkActor::MakeProperty ( )
virtual

Create a new property suitable for use with this type of Actor.

For example, a vtkMesaActor should create a vtkMesaProperty in this function. The default is to just call vtkProperty::New.

◆ SetBackfaceProperty()

void vtkActor::SetBackfaceProperty ( vtkProperty lut)

Set/Get the property object that controls this actors backface surface properties.

This should be an instance of a vtkProperty object. If one isn't specified, then the front face properties will be used. Multiple actors can share one property object.

◆ GetBackfaceProperty()

virtual vtkProperty * vtkActor::GetBackfaceProperty ( )
virtual

Set/Get the property object that controls this actors backface surface properties.

This should be an instance of a vtkProperty object. If one isn't specified, then the front face properties will be used. Multiple actors can share one property object.

◆ SetTexture()

virtual void vtkActor::SetTexture ( vtkTexture )
virtual

Set/Get the texture object to control rendering texture maps.

This will be a vtkTexture object. An actor does not need to have an associated texture map and multiple actors can share one texture.

◆ GetTexture()

virtual vtkTexture * vtkActor::GetTexture ( )
virtual

Set/Get the texture object to control rendering texture maps.

This will be a vtkTexture object. An actor does not need to have an associated texture map and multiple actors can share one texture.

◆ SetMapper()

virtual void vtkActor::SetMapper ( vtkMapper )
virtual

This is the method that is used to connect an actor to the end of a visualization pipeline, i.e.

the mapper. This should be a subclass of vtkMapper. Typically vtkPolyDataMapper and vtkDataSetMapper will be used.

◆ GetMapper()

virtual vtkMapper * vtkActor::GetMapper ( )
virtual

Returns the Mapper that this actor is getting its data from.

◆ GetBounds() [1/3]

double * vtkActor::GetBounds ( )
overridevirtual

Return a reference to the Prop3D's composite transform.

Get the bounds for this Prop3D as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

Implements vtkProp3D.

Reimplemented in vtkCubeAxesActor, vtkFlagpoleLabel, vtkFlagpoleLabel, vtkSkybox, vtkSkybox, vtkOpenGLAvatar, vtkFlagpoleLabel, and vtkSkybox.

◆ ApplyProperties()

virtual void vtkActor::ApplyProperties ( )
inlinevirtual

Apply the current properties to all parts that compose this actor.

This method is overloaded in vtkAssembly to apply the assemblies' properties to all its parts in a recursive manner. Typically the use of this method is to set the desired properties in the assembly, and then push the properties down to the assemblies parts with ApplyProperties().

Definition at line 280 of file vtkActor.h.

◆ GetMTime()

vtkMTimeType vtkActor::GetMTime ( )
overridevirtual

Get the actors mtime plus consider its properties and texture if set.

Reimplemented from vtkObject.

◆ GetRedrawMTime()

vtkMTimeType vtkActor::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, textures, etc.

Reimplemented from vtkProp.

◆ GetForceOpaque()

virtual bool vtkActor::GetForceOpaque ( )
virtual

Force the actor to be treated as opaque or translucent.

Reimplemented in vtkFlagpoleLabel.

◆ SetForceOpaque()

virtual void vtkActor::SetForceOpaque ( bool  )
virtual

Force the actor to be treated as opaque or translucent.

Reimplemented in vtkFlagpoleLabel.

◆ ForceOpaqueOn()

virtual void vtkActor::ForceOpaqueOn ( )
virtual

Force the actor to be treated as opaque or translucent.

Reimplemented in vtkFlagpoleLabel.

◆ ForceOpaqueOff()

virtual void vtkActor::ForceOpaqueOff ( )
virtual

Force the actor to be treated as opaque or translucent.

Reimplemented in vtkFlagpoleLabel.

◆ GetForceTranslucent()

virtual bool vtkActor::GetForceTranslucent ( )
virtual

Force the actor to be treated as opaque or translucent.

Reimplemented in vtkFlagpoleLabel.

◆ SetForceTranslucent()

virtual void vtkActor::SetForceTranslucent ( bool  )
virtual

Force the actor to be treated as opaque or translucent.

Reimplemented in vtkFlagpoleLabel.

◆ ForceTranslucentOn()

virtual void vtkActor::ForceTranslucentOn ( )
virtual

Force the actor to be treated as opaque or translucent.

Reimplemented in vtkFlagpoleLabel.

◆ ForceTranslucentOff()

virtual void vtkActor::ForceTranslucentOff ( )
virtual

Force the actor to be treated as opaque or translucent.

Reimplemented in vtkFlagpoleLabel.

◆ GetSupportsSelection()

bool vtkActor::GetSupportsSelection ( )
overridevirtual

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.

Reimplemented from vtkProp.

◆ ProcessSelectorPixelBuffers()

void vtkActor::ProcessSelectorPixelBuffers ( vtkHardwareSelector sel,
std::vector< unsigned int > &  pixeloffsets 
)
overridevirtual

allows a prop to update a selections color buffers Default just forwards to the Mapper

Reimplemented from vtkProp.

◆ IsRenderingTranslucentPolygonalGeometry()

bool vtkActor::IsRenderingTranslucentPolygonalGeometry ( )
inlineoverridevirtual

Reimplemented from vtkProp.

Definition at line 324 of file vtkActor.h.

◆ SetIsRenderingTranslucentPolygonalGeometry()

void vtkActor::SetIsRenderingTranslucentPolygonalGeometry ( bool  val)
inline

Definition at line 325 of file vtkActor.h.

◆ GetIsOpaque()

int vtkActor::GetIsOpaque ( )
protected

◆ GetBounds() [2/3]

void vtkProp3D::GetBounds ( double  bounds[6])

Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

(The method GetBounds(double bounds[6]) is available from the superclass.)

◆ GetBounds() [3/3]

double * vtkProp3D::GetBounds ( void  )
overridevirtual

Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

(The method GetBounds(double bounds[6]) is available from the superclass.)

Implements vtkProp3D.

Reimplemented in vtkFlagpoleLabel, vtkSkybox, vtkFlagpoleLabel, and vtkSkybox.

Member Data Documentation

◆ ForceOpaque

bool vtkActor::ForceOpaque
protected

Definition at line 334 of file vtkActor.h.

◆ ForceTranslucent

bool vtkActor::ForceTranslucent
protected

Definition at line 335 of file vtkActor.h.

◆ InTranslucentPass

bool vtkActor::InTranslucentPass
protected

Definition at line 336 of file vtkActor.h.

◆ Property

vtkProperty* vtkActor::Property
protected

Definition at line 338 of file vtkActor.h.

◆ BackfaceProperty

vtkProperty* vtkActor::BackfaceProperty
protected

Definition at line 339 of file vtkActor.h.

◆ Texture

vtkTexture* vtkActor::Texture
protected

Definition at line 340 of file vtkActor.h.

◆ Mapper

vtkMapper* vtkActor::Mapper
protected

Definition at line 341 of file vtkActor.h.

◆ MapperBounds

double vtkActor::MapperBounds[6]
protected

Definition at line 345 of file vtkActor.h.

◆ BoundsMTime

vtkTimeStamp vtkActor::BoundsMTime
protected

Definition at line 346 of file vtkActor.h.


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