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.vtkVolumeOutlineSource Class Reference

vtkVolumeOutlineSource - outline of volume cropping region More...

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

List of all members.

Public Member Functions

 vtkVolumeOutlineSource (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkVolumeOutlineSource ()
 Undocumented Block.
virtual void GenerateFacesOff ()
 Set whether to generate polygonal faces for the output. By default, only lines are generated. The faces will form a closed, watertight surface.
virtual void GenerateFacesOn ()
 Set whether to generate polygonal faces for the output. By default, only lines are generated. The faces will form a closed, watertight surface.
virtual void GenerateOutlineOff ()
 Set whether to generate an outline wherever an input face was cut by a plane. This is on by default.
virtual void GenerateOutlineOn ()
 Set whether to generate an outline wherever an input face was cut by a plane. This is on by default.
virtual void GenerateScalarsOff ()
 Set whether to generate color scalars for the output. By default, the output has no scalars and the color must be set in the property of the actor.
virtual void GenerateScalarsOn ()
 Set whether to generate color scalars for the output. By default, the output has no scalars and the color must be set in the property of the actor.
virtual double[] GetActivePlaneColor ()
 Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.
virtual void GetActivePlaneColor (ref double _arg1, ref double _arg2, ref double _arg3)
 Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.
virtual void GetActivePlaneColor (IntPtr _arg)
 Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.
virtual int GetActivePlaneId ()
 Set the active plane, e.g. to display which plane is currently being modified by an interaction. Set this to -1 if there is no active plane. The default value is -1.
virtual double[] GetColor ()
 Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.
virtual void GetColor (ref double _arg1, ref double _arg2, ref double _arg3)
 Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.
virtual void GetColor (IntPtr _arg)
 Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.
virtual int GetGenerateFaces ()
 Set whether to generate polygonal faces for the output. By default, only lines are generated. The faces will form a closed, watertight surface.
virtual int GetGenerateOutline ()
 Set whether to generate an outline wherever an input face was cut by a plane. This is on by default.
virtual int GetGenerateScalars ()
 Set whether to generate color scalars for the output. By default, the output has no scalars and the color must be set in the property of the actor.
vtkVolumeMapper GetVolumeMapper ()
 Set the mapper that has the cropping region that the outline will be generated for. The mapper must have an input, because the bounds of the data must be computed in order to generate the outline.
override int IsA (string type)
 Undocumented Block.
new vtkVolumeOutlineSource NewInstance ()
 Undocumented Block.
virtual void SetActivePlaneColor (double _arg1, double _arg2, double _arg3)
 Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.
virtual void SetActivePlaneColor (IntPtr _arg)
 Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.
virtual void SetActivePlaneId (int _arg)
 Set the active plane, e.g. to display which plane is currently being modified by an interaction. Set this to -1 if there is no active plane. The default value is -1.
virtual void SetColor (double _arg1, double _arg2, double _arg3)
 Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.
virtual void SetColor (IntPtr _arg)
 Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.
virtual void SetGenerateFaces (int _arg)
 Set whether to generate polygonal faces for the output. By default, only lines are generated. The faces will form a closed, watertight surface.
virtual void SetGenerateOutline (int _arg)
 Set whether to generate an outline wherever an input face was cut by a plane. This is on by default.
virtual void SetGenerateScalars (int _arg)
 Set whether to generate color scalars for the output. By default, the output has no scalars and the color must be set in the property of the actor.
virtual void SetVolumeMapper (vtkVolumeMapper mapper)
 Set the mapper that has the cropping region that the outline will be generated for. The mapper must have an input, because the bounds of the data must be computed in order to generate the outline.

Static Public Member Functions

static new vtkVolumeOutlineSource New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkVolumeOutlineSource SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "22vtkVolumeOutlineSource"
 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 vtkVolumeOutlineSource_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkVolumeOutlineSource_GenerateFacesOff_01 (HandleRef pThis)
static internal void vtkVolumeOutlineSource_GenerateFacesOn_02 (HandleRef pThis)
static internal void vtkVolumeOutlineSource_GenerateOutlineOff_03 (HandleRef pThis)
static internal void vtkVolumeOutlineSource_GenerateOutlineOn_04 (HandleRef pThis)
static internal void vtkVolumeOutlineSource_GenerateScalarsOff_05 (HandleRef pThis)
static internal void vtkVolumeOutlineSource_GenerateScalarsOn_06 (HandleRef pThis)
static internal IntPtr vtkVolumeOutlineSource_GetActivePlaneColor_07 (HandleRef pThis)
static internal void vtkVolumeOutlineSource_GetActivePlaneColor_08 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3)
static internal void vtkVolumeOutlineSource_GetActivePlaneColor_09 (HandleRef pThis, IntPtr _arg)
static internal int vtkVolumeOutlineSource_GetActivePlaneId_10 (HandleRef pThis)
static internal IntPtr vtkVolumeOutlineSource_GetColor_11 (HandleRef pThis)
static internal void vtkVolumeOutlineSource_GetColor_12 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3)
static internal void vtkVolumeOutlineSource_GetColor_13 (HandleRef pThis, IntPtr _arg)
static internal int vtkVolumeOutlineSource_GetGenerateFaces_14 (HandleRef pThis)
static internal int vtkVolumeOutlineSource_GetGenerateOutline_15 (HandleRef pThis)
static internal int vtkVolumeOutlineSource_GetGenerateScalars_16 (HandleRef pThis)
static internal IntPtr vtkVolumeOutlineSource_GetVolumeMapper_17 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkVolumeOutlineSource_IsA_18 (HandleRef pThis, string type)
static internal int vtkVolumeOutlineSource_IsTypeOf_19 (string type)
static internal IntPtr vtkVolumeOutlineSource_NewInstance_21 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkVolumeOutlineSource_SafeDownCast_22 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkVolumeOutlineSource_SetActivePlaneColor_23 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkVolumeOutlineSource_SetActivePlaneColor_24 (HandleRef pThis, IntPtr _arg)
static internal void vtkVolumeOutlineSource_SetActivePlaneId_25 (HandleRef pThis, int _arg)
static internal void vtkVolumeOutlineSource_SetColor_26 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkVolumeOutlineSource_SetColor_27 (HandleRef pThis, IntPtr _arg)
static internal void vtkVolumeOutlineSource_SetGenerateFaces_28 (HandleRef pThis, int _arg)
static internal void vtkVolumeOutlineSource_SetGenerateOutline_29 (HandleRef pThis, int _arg)
static internal void vtkVolumeOutlineSource_SetGenerateScalars_30 (HandleRef pThis, int _arg)
static internal void vtkVolumeOutlineSource_SetVolumeMapper_31 (HandleRef pThis, HandleRef mapper)

Static Private Member Functions

static vtkVolumeOutlineSource ()
 Automatically generated type registration mechanics.

Detailed Description

vtkVolumeOutlineSource - outline of volume cropping region

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


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkVolumeOutlineSource.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.vtkPolyDataAlgorithm.

Set whether to generate polygonal faces for the output. By default, only lines are generated. The faces will form a closed, watertight surface.

Set whether to generate polygonal faces for the output. By default, only lines are generated. The faces will form a closed, watertight surface.

Set whether to generate an outline wherever an input face was cut by a plane. This is on by default.

Set whether to generate an outline wherever an input face was cut by a plane. This is on by default.

Set whether to generate color scalars for the output. By default, the output has no scalars and the color must be set in the property of the actor.

Set whether to generate color scalars for the output. By default, the output has no scalars and the color must be set in the property of the actor.

Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.

virtual void Kitware.VTK.vtkVolumeOutlineSource.GetActivePlaneColor ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [virtual]

Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.

virtual void Kitware.VTK.vtkVolumeOutlineSource.GetActivePlaneColor ( IntPtr  _arg) [virtual]

Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.

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

virtual double [] Kitware.VTK.vtkVolumeOutlineSource.GetColor ( ) [virtual]

Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.

virtual void Kitware.VTK.vtkVolumeOutlineSource.GetColor ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [virtual]

Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.

virtual void Kitware.VTK.vtkVolumeOutlineSource.GetColor ( IntPtr  _arg) [virtual]

Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.

Set whether to generate polygonal faces for the output. By default, only lines are generated. The faces will form a closed, watertight surface.

Set whether to generate an outline wherever an input face was cut by a plane. This is on by default.

Set whether to generate color scalars for the output. By default, the output has no scalars and the color must be set in the property of the actor.

Set the mapper that has the cropping region that the outline will be generated for. The mapper must have an input, because the bounds of the data must be computed in order to generate the outline.

Here is the call graph for this function:

override int Kitware.VTK.vtkVolumeOutlineSource.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

static new int Kitware.VTK.vtkVolumeOutlineSource.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkVolumeOutlineSource.SetActivePlaneColor ( double  _arg1,
double  _arg2,
double  _arg3 
) [virtual]

Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.

virtual void Kitware.VTK.vtkVolumeOutlineSource.SetActivePlaneColor ( IntPtr  _arg) [virtual]

Set the color of the active cropping plane. This has no effect unless GenerateScalars is On and ActivePlaneId is non-negative. The default color is yellow.

virtual void Kitware.VTK.vtkVolumeOutlineSource.SetActivePlaneId ( int  _arg) [virtual]

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

virtual void Kitware.VTK.vtkVolumeOutlineSource.SetColor ( double  _arg1,
double  _arg2,
double  _arg3 
) [virtual]

Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.

virtual void Kitware.VTK.vtkVolumeOutlineSource.SetColor ( IntPtr  _arg) [virtual]

Set the color of the outline. This has no effect unless GenerateScalars is On. The default color is red.

virtual void Kitware.VTK.vtkVolumeOutlineSource.SetGenerateFaces ( int  _arg) [virtual]

Set whether to generate polygonal faces for the output. By default, only lines are generated. The faces will form a closed, watertight surface.

virtual void Kitware.VTK.vtkVolumeOutlineSource.SetGenerateOutline ( int  _arg) [virtual]

Set whether to generate an outline wherever an input face was cut by a plane. This is on by default.

virtual void Kitware.VTK.vtkVolumeOutlineSource.SetGenerateScalars ( int  _arg) [virtual]

Set whether to generate color scalars for the output. By default, the output has no scalars and the color must be set in the property of the actor.

Set the mapper that has the cropping region that the outline will be generated for. The mapper must have an input, because the bounds of the data must be computed in order to generate the outline.

static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GenerateFacesOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GenerateFacesOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GenerateOutlineOff_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GenerateOutlineOn_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GenerateScalarsOff_05 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GenerateScalarsOn_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GetActivePlaneColor_07 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GetActivePlaneColor_08 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GetActivePlaneColor_09 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal int Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GetActivePlaneId_10 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GetColor_11 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GetColor_12 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GetColor_13 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal int Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GetGenerateFaces_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GetGenerateOutline_15 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GetGenerateScalars_16 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_GetVolumeMapper_17 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_IsA_18 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_IsTypeOf_19 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_NewInstance_21 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_SafeDownCast_22 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_SetActivePlaneColor_23 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_SetActivePlaneColor_24 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_SetActivePlaneId_25 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_SetColor_26 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_SetColor_27 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_SetGenerateFaces_28 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_SetGenerateOutline_29 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_SetGenerateScalars_30 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkVolumeOutlineSource.vtkVolumeOutlineSource_SetVolumeMapper_31 ( HandleRef  pThis,
HandleRef  mapper 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkVolumeOutlineSource.MRClassNameKey = "22vtkVolumeOutlineSource" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

new const string Kitware.VTK.vtkVolumeOutlineSource.MRFullTypeName = "Kitware.VTK.vtkVolumeOutlineSource"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.


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