ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkActor Class Reference

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

Inheritance diagram for Kitware.VTK.vtkActor:
[legend]
Collaboration diagram for Kitware.VTK.vtkActor:
[legend]

List of all members.

Public Member Functions

 vtkActor (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkActor ()
 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.
virtual void ApplyProperties ()
 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().
override void GetActors (vtkPropCollection arg0)
 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.
virtual vtkProperty GetBackfaceProperty ()
 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.
new void GetBounds (IntPtr bounds)
 Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). (The method GetBounds(double bounds[6]) is available from the superclass.)
override double[] GetBounds ()
 Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). (The method GetBounds(double bounds[6]) is available from the superclass.)
override uint GetMTime ()
 Get the actors mtime plus consider its properties and texture if set.
virtual vtkMapper GetMapper ()
 Returns the Mapper that this actor is getting its data from.
vtkProperty 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.
override uint GetRedrawMTime ()
 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.
override 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 vtkTexture GetTexture ()
 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.
override int HasTranslucentPolygonalGeometry ()
 Does this prop have some translucent polygonal geometry?
override int IsA (string type)
 Undocumented Block.
virtual vtkProperty MakeProperty ()
 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.
new vtkActor NewInstance ()
 Undocumented Block.
override void ReleaseGraphicsResources (vtkWindow arg0)
 Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.
virtual void Render (vtkRenderer arg0, vtkMapper arg1)
 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.
override int RenderOpaqueGeometry (vtkViewport viewport)
 Support the standard render methods.
override int RenderTranslucentPolygonalGeometry (vtkViewport viewport)
 Support the standard render methods.
void 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.
virtual void SetMapper (vtkMapper arg0)
 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.
void 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.
virtual void SetTexture (vtkTexture arg0)
 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.
override void ShallowCopy (vtkProp prop)
 Shallow copy of an actor. Overloads the virtual vtkProp method.

Static Public Member Functions

static new vtkActor New ()
 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.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkActor SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkActor"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "8vtkActor"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkActor_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkActor_ApplyProperties_01 (HandleRef pThis)
static internal void vtkActor_GetActors_02 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkActor_GetBackfaceProperty_03 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkActor_GetBounds_04 (HandleRef pThis, IntPtr bounds)
static internal IntPtr vtkActor_GetBounds_05 (HandleRef pThis)
static internal uint vtkActor_GetMTime_06 (HandleRef pThis)
static internal IntPtr vtkActor_GetMapper_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkActor_GetProperty_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint vtkActor_GetRedrawMTime_09 (HandleRef pThis)
static internal byte vtkActor_GetSupportsSelection_10 (HandleRef pThis)
static internal IntPtr vtkActor_GetTexture_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkActor_HasTranslucentPolygonalGeometry_12 (HandleRef pThis)
static internal int vtkActor_IsA_13 (HandleRef pThis, string type)
static internal int vtkActor_IsTypeOf_14 (string type)
static internal IntPtr vtkActor_MakeProperty_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkActor_NewInstance_17 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkActor_ReleaseGraphicsResources_18 (HandleRef pThis, HandleRef arg0)
static internal void vtkActor_Render_19 (HandleRef pThis, HandleRef arg0, HandleRef arg1)
static internal int vtkActor_RenderOpaqueGeometry_20 (HandleRef pThis, HandleRef viewport)
static internal int vtkActor_RenderTranslucentPolygonalGeometry_21 (HandleRef pThis, HandleRef viewport)
static internal IntPtr vtkActor_SafeDownCast_22 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkActor_SetBackfaceProperty_23 (HandleRef pThis, HandleRef lut)
static internal void vtkActor_SetMapper_24 (HandleRef pThis, HandleRef arg0)
static internal void vtkActor_SetProperty_25 (HandleRef pThis, HandleRef lut)
static internal void vtkActor_SetTexture_26 (HandleRef pThis, HandleRef arg0)
static internal void vtkActor_ShallowCopy_27 (HandleRef pThis, HandleRef prop)

Static Private Member Functions

static vtkActor ()
 Automatically generated type registration mechanics.

Detailed Description

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

Description

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)


Constructor & Destructor Documentation

static Kitware.VTK.vtkActor.vtkActor ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkActor.vtkActor ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

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.


Member Function Documentation

virtual void Kitware.VTK.vtkActor.ApplyProperties ( ) [virtual]

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().

override void Kitware.VTK.vtkActor.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkProp3D.

Reimplemented in Kitware.VTK.vtkCubeAxesActor, Kitware.VTK.vtkAxisActor, Kitware.VTK.vtkLODActor, Kitware.VTK.vtkQuadricLODActor, Kitware.VTK.vtkFollower, and Kitware.VTK.vtkOpenGLActor.

override void Kitware.VTK.vtkActor.GetActors ( vtkPropCollection  arg0) [virtual]

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 Kitware.VTK.vtkProp.

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.

Here is the call graph for this function:

new void Kitware.VTK.vtkActor.GetBounds ( IntPtr  bounds)

Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). (The method GetBounds(double bounds[6]) is available from the superclass.)

Reimplemented from Kitware.VTK.vtkProp3D.

Reimplemented in Kitware.VTK.vtkAxisActor, and Kitware.VTK.vtkCubeAxesActor.

override double [] Kitware.VTK.vtkActor.GetBounds ( ) [virtual]

Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). (The method GetBounds(double bounds[6]) is available from the superclass.)

Reimplemented from Kitware.VTK.vtkProp3D.

Reimplemented in Kitware.VTK.vtkAxisActor, and Kitware.VTK.vtkCubeAxesActor.

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

Here is the call graph for this function:

override uint Kitware.VTK.vtkActor.GetMTime ( ) [virtual]

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

Reimplemented from Kitware.VTK.vtkProp3D.

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.

Here is the call graph for this function:

override uint Kitware.VTK.vtkActor.GetRedrawMTime ( ) [virtual]

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 Kitware.VTK.vtkProp.

override bool Kitware.VTK.vtkActor.GetSupportsSelection ( ) [virtual]

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 Kitware.VTK.vtkProp.

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.

Here is the call graph for this function:

Does this prop have some translucent polygonal geometry?

Reimplemented from Kitware.VTK.vtkProp.

Reimplemented in Kitware.VTK.vtkFollower.

override int Kitware.VTK.vtkActor.IsA ( string  type) [virtual]
static new int Kitware.VTK.vtkActor.IsTypeOf ( string  type) [static]

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.

Here is the call graph for this function:

static new vtkActor Kitware.VTK.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.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkAxisActor, Kitware.VTK.vtkCubeAxesActor, Kitware.VTK.vtkQuadricLODActor, Kitware.VTK.vtkLODActor, Kitware.VTK.vtkFollower, and Kitware.VTK.vtkOpenGLActor.

override void Kitware.VTK.vtkActor.ReleaseGraphicsResources ( vtkWindow  arg0) [virtual]

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 Kitware.VTK.vtkProp.

Reimplemented in Kitware.VTK.vtkCubeAxesActor, Kitware.VTK.vtkAxisActor, Kitware.VTK.vtkQuadricLODActor, Kitware.VTK.vtkLODActor, and Kitware.VTK.vtkFollower.

virtual void Kitware.VTK.vtkActor.Render ( vtkRenderer  arg0,
vtkMapper  arg1 
) [virtual]

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 Kitware.VTK.vtkQuadricLODActor, Kitware.VTK.vtkLODActor, and Kitware.VTK.vtkOpenGLActor.

override int Kitware.VTK.vtkActor.RenderOpaqueGeometry ( vtkViewport  viewport) [virtual]

Support the standard render methods.

Reimplemented from Kitware.VTK.vtkProp.

Reimplemented in Kitware.VTK.vtkFollower.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkProp3D.

Reimplemented in Kitware.VTK.vtkCubeAxesActor, Kitware.VTK.vtkAxisActor, Kitware.VTK.vtkQuadricLODActor, Kitware.VTK.vtkLODActor, Kitware.VTK.vtkFollower, and Kitware.VTK.vtkOpenGLActor.

Here is the call graph for this function:

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.

virtual void Kitware.VTK.vtkActor.SetMapper ( vtkMapper  arg0) [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.

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.

virtual void Kitware.VTK.vtkActor.SetTexture ( vtkTexture  arg0) [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.

override void Kitware.VTK.vtkActor.ShallowCopy ( vtkProp  prop) [virtual]

Shallow copy of an actor. Overloads the virtual vtkProp method.

Reimplemented from Kitware.VTK.vtkProp3D.

Reimplemented in Kitware.VTK.vtkAxisActor, Kitware.VTK.vtkQuadricLODActor, Kitware.VTK.vtkLODActor, and Kitware.VTK.vtkFollower.

static internal void Kitware.VTK.vtkActor.vtkActor_ApplyProperties_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkActor.vtkActor_GetActors_02 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkActor.vtkActor_GetBackfaceProperty_03 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkActor.vtkActor_GetBounds_04 ( HandleRef  pThis,
IntPtr  bounds 
) [private]
static internal IntPtr Kitware.VTK.vtkActor.vtkActor_GetBounds_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkActor.vtkActor_GetMapper_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal uint Kitware.VTK.vtkActor.vtkActor_GetMTime_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkActor.vtkActor_GetProperty_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal uint Kitware.VTK.vtkActor.vtkActor_GetRedrawMTime_09 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkActor.vtkActor_GetSupportsSelection_10 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkActor.vtkActor_GetTexture_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkActor.vtkActor_HasTranslucentPolygonalGeometry_12 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkActor.vtkActor_IsA_13 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkActor.vtkActor_IsTypeOf_14 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkActor.vtkActor_MakeProperty_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkActor.vtkActor_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkActor.vtkActor_NewInstance_17 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkActor.vtkActor_ReleaseGraphicsResources_18 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkActor.vtkActor_Render_19 ( HandleRef  pThis,
HandleRef  arg0,
HandleRef  arg1 
) [private]
static internal int Kitware.VTK.vtkActor.vtkActor_RenderOpaqueGeometry_20 ( HandleRef  pThis,
HandleRef  viewport 
) [private]
static internal int Kitware.VTK.vtkActor.vtkActor_RenderTranslucentPolygonalGeometry_21 ( HandleRef  pThis,
HandleRef  viewport 
) [private]
static internal IntPtr Kitware.VTK.vtkActor.vtkActor_SafeDownCast_22 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkActor.vtkActor_SetBackfaceProperty_23 ( HandleRef  pThis,
HandleRef  lut 
) [private]
static internal void Kitware.VTK.vtkActor.vtkActor_SetMapper_24 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkActor.vtkActor_SetProperty_25 ( HandleRef  pThis,
HandleRef  lut 
) [private]
static internal void Kitware.VTK.vtkActor.vtkActor_SetTexture_26 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkActor.vtkActor_ShallowCopy_27 ( HandleRef  pThis,
HandleRef  prop 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkActor.MRClassNameKey = "8vtkActor" [static]
new const string Kitware.VTK.vtkActor.MRFullTypeName = "Kitware.VTK.vtkActor"

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