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

vtkCoordinate - perform coordinate transformation, and represent position, in a variety of vtk coordinate systems More...

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

List of all members.

Public Member Functions

 vtkCoordinate (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkCoordinate ()
 Creates an instance of this class with the following defaults: value of (0,0,0) in world coordinates.
int[] GetComputedDisplayValue (vtkViewport arg0)
 Return the computed value in a specified coordinate system.
double[] GetComputedDoubleDisplayValue (vtkViewport arg0)
 Return the computed value in a specified coordinate system.
double[] GetComputedDoubleViewportValue (vtkViewport arg0)
 Return the computed value in a specified coordinate system.
int[] GetComputedLocalDisplayValue (vtkViewport arg0)
 Return the computed value in a specified coordinate system.
virtual IntPtr GetComputedUserDefinedValue (vtkViewport arg0)
 GetComputedUserDefinedValue() is to be used only when the coordinate system is VTK_USERDEFINED. The user must subclass vtkCoordinate and override this function, when set as the TransformCoordinate in 2D-Mappers, the user can customize display of 2D polygons.
IntPtr GetComputedValue (vtkViewport arg0)
 GetComputedValue() will return either World, Viewport or Display based on what has been set as the coordinate system. This is good for objects like vtkLineSource, where the user might want to use them as World or Viewport coordinates.
int[] GetComputedViewportValue (vtkViewport arg0)
 Return the computed value in a specified coordinate system.
double[] GetComputedWorldValue (vtkViewport arg0)
 Return the computed value in a specified coordinate system.
virtual int GetCoordinateSystem ()
 Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.
string GetCoordinateSystemAsString ()
 Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.
virtual vtkCoordinate GetReferenceCoordinate ()
 If this coordinate is relative to another coordinate, then specify that coordinate as the ReferenceCoordinate. If this is NULL the coordinate is assumed to be absolute.
virtual double[] GetValue ()
 Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.
virtual void GetValue (ref double _arg1, ref double _arg2, ref double _arg3)
 Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.
virtual void GetValue (IntPtr _arg)
 Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.
virtual vtkViewport GetViewport ()
 If you want this coordinate to be relative to a specific vtkViewport (vtkRenderer) then you can specify that here. NOTE: this is a raw pointer, not a weak pointer not a reference counted object to avoid reference cycle loop between rendering classes and filter classes.
override int IsA (string type)
 Undocumented Block.
new vtkCoordinate NewInstance ()
 Undocumented Block.
virtual void SetCoordinateSystem (int _arg)
 Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.
void SetCoordinateSystemToDisplay ()
 Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.
void SetCoordinateSystemToNormalizedDisplay ()
 Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.
void SetCoordinateSystemToNormalizedViewport ()
 Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.
void SetCoordinateSystemToView ()
 Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.
void SetCoordinateSystemToViewport ()
 Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.
void SetCoordinateSystemToWorld ()
 Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.
virtual void SetReferenceCoordinate (vtkCoordinate arg0)
 If this coordinate is relative to another coordinate, then specify that coordinate as the ReferenceCoordinate. If this is NULL the coordinate is assumed to be absolute.
virtual void SetValue (double _arg1, double _arg2, double _arg3)
 Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.
virtual void SetValue (IntPtr _arg)
 Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.
void SetValue (double a, double b)
 Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.
void SetViewport (vtkViewport viewport)
 If you want this coordinate to be relative to a specific vtkViewport (vtkRenderer) then you can specify that here. NOTE: this is a raw pointer, not a weak pointer not a reference counted object to avoid reference cycle loop between rendering classes and filter classes.

Static Public Member Functions

static new vtkCoordinate New ()
 Creates an instance of this class with the following defaults: value of (0,0,0) in world coordinates.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkCoordinate SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "13vtkCoordinate"
 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 vtkCoordinate_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCoordinate_GetComputedDisplayValue_01 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkCoordinate_GetComputedDoubleDisplayValue_02 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkCoordinate_GetComputedDoubleViewportValue_03 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkCoordinate_GetComputedLocalDisplayValue_04 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkCoordinate_GetComputedUserDefinedValue_05 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkCoordinate_GetComputedValue_06 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkCoordinate_GetComputedViewportValue_07 (HandleRef pThis, HandleRef arg0)
static internal IntPtr vtkCoordinate_GetComputedWorldValue_08 (HandleRef pThis, HandleRef arg0)
static internal int vtkCoordinate_GetCoordinateSystem_09 (HandleRef pThis)
static internal IntPtr vtkCoordinate_GetCoordinateSystemAsString_10 (HandleRef pThis)
static internal IntPtr vtkCoordinate_GetReferenceCoordinate_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCoordinate_GetValue_12 (HandleRef pThis)
static internal void vtkCoordinate_GetValue_13 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3)
static internal void vtkCoordinate_GetValue_14 (HandleRef pThis, IntPtr _arg)
static internal IntPtr vtkCoordinate_GetViewport_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkCoordinate_IsA_16 (HandleRef pThis, string type)
static internal int vtkCoordinate_IsTypeOf_17 (string type)
static internal IntPtr vtkCoordinate_NewInstance_19 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkCoordinate_SafeDownCast_20 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkCoordinate_SetCoordinateSystem_21 (HandleRef pThis, int _arg)
static internal void vtkCoordinate_SetCoordinateSystemToDisplay_22 (HandleRef pThis)
static internal void vtkCoordinate_SetCoordinateSystemToNormalizedDisplay_23 (HandleRef pThis)
static internal void vtkCoordinate_SetCoordinateSystemToNormalizedViewport_24 (HandleRef pThis)
static internal void vtkCoordinate_SetCoordinateSystemToView_25 (HandleRef pThis)
static internal void vtkCoordinate_SetCoordinateSystemToViewport_26 (HandleRef pThis)
static internal void vtkCoordinate_SetCoordinateSystemToWorld_27 (HandleRef pThis)
static internal void vtkCoordinate_SetReferenceCoordinate_28 (HandleRef pThis, HandleRef arg0)
static internal void vtkCoordinate_SetValue_29 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkCoordinate_SetValue_30 (HandleRef pThis, IntPtr _arg)
static internal void vtkCoordinate_SetValue_31 (HandleRef pThis, double a, double b)
static internal void vtkCoordinate_SetViewport_32 (HandleRef pThis, HandleRef viewport)

Static Private Member Functions

static vtkCoordinate ()
 Automatically generated type registration mechanics.

Detailed Description

vtkCoordinate - perform coordinate transformation, and represent position, in a variety of vtk coordinate systems

Description vtkCoordinate represents position in a variety of coordinate systems, and converts position to other coordinate systems. It also supports relative positioning, so you can create a cascade of vtkCoordinate objects (no loops please!) that refer to each other. The typical usage of this object is to set the coordinate system in which to represent a position (e.g., SetCoordinateSystemToNormalizedDisplay()), set the value of the coordinate (e.g., SetValue()), and then invoke the appropriate method to convert to another coordinate system (e.g., GetComputedWorldValue()).

The coordinate systems in vtk are as follows: <PRE> DISPLAY - x-y pixel values in window NORMALIZED DISPLAY - x-y (0,1) normalized values VIEWPORT - x-y pixel values in viewport NORMALIZED VIEWPORT - x-y (0,1) normalized value in viewport VIEW - x-y-z (-1,1) values in camera coordinates. (z is depth) WORLD - x-y-z global coordinate values USERDEFINED - x-y-z in User defined space </PRE>

If you cascade vtkCoordinate objects, you refer to another vtkCoordinate object which in turn can refer to others, and so on. This allows you to create composite groups of things like vtkActor2D that are positioned relative to one another. Note that in cascaded sequences, each vtkCoordinate object may be specified in different coordinate systems!


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Creates an instance of this class with the following defaults: value of (0,0,0) in world coordinates.


Member Function Documentation

override void Kitware.VTK.vtkCoordinate.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.vtkObject.

Return the computed value in a specified coordinate system.

Return the computed value in a specified coordinate system.

Return the computed value in a specified coordinate system.

Return the computed value in a specified coordinate system.

GetComputedUserDefinedValue() is to be used only when the coordinate system is VTK_USERDEFINED. The user must subclass vtkCoordinate and override this function, when set as the TransformCoordinate in 2D-Mappers, the user can customize display of 2D polygons.

GetComputedValue() will return either World, Viewport or Display based on what has been set as the coordinate system. This is good for objects like vtkLineSource, where the user might want to use them as World or Viewport coordinates.

Return the computed value in a specified coordinate system.

Return the computed value in a specified coordinate system.

Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.

Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.

If this coordinate is relative to another coordinate, then specify that coordinate as the ReferenceCoordinate. If this is NULL the coordinate is assumed to be absolute.

Here is the call graph for this function:

virtual double [] Kitware.VTK.vtkCoordinate.GetValue ( ) [virtual]

Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.

virtual void Kitware.VTK.vtkCoordinate.GetValue ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [virtual]

Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.

virtual void Kitware.VTK.vtkCoordinate.GetValue ( IntPtr  _arg) [virtual]

Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.

If you want this coordinate to be relative to a specific vtkViewport (vtkRenderer) then you can specify that here. NOTE: this is a raw pointer, not a weak pointer not a reference counted object to avoid reference cycle loop between rendering classes and filter classes.

Here is the call graph for this function:

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Creates an instance of this class with the following defaults: value of (0,0,0) in world coordinates.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkCoordinate.SetCoordinateSystem ( int  _arg) [virtual]

Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.

Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.

Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.

Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.

Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.

Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.

Set/get the coordinate system which this coordinate is defined in. The options are Display, Normalized Display, Viewport, Normalized Viewport, View, and World.

If this coordinate is relative to another coordinate, then specify that coordinate as the ReferenceCoordinate. If this is NULL the coordinate is assumed to be absolute.

virtual void Kitware.VTK.vtkCoordinate.SetValue ( double  _arg1,
double  _arg2,
double  _arg3 
) [virtual]

Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.

virtual void Kitware.VTK.vtkCoordinate.SetValue ( IntPtr  _arg) [virtual]

Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.

void Kitware.VTK.vtkCoordinate.SetValue ( double  a,
double  b 
)

Set/get the value of this coordinate. This can be thought of as the position of this coordinate in its coordinate system.

If you want this coordinate to be relative to a specific vtkViewport (vtkRenderer) then you can specify that here. NOTE: this is a raw pointer, not a weak pointer not a reference counted object to avoid reference cycle loop between rendering classes and filter classes.

static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_GetComputedDisplayValue_01 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_GetComputedDoubleDisplayValue_02 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_GetComputedDoubleViewportValue_03 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_GetComputedLocalDisplayValue_04 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_GetComputedUserDefinedValue_05 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_GetComputedValue_06 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_GetComputedViewportValue_07 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_GetComputedWorldValue_08 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal int Kitware.VTK.vtkCoordinate.vtkCoordinate_GetCoordinateSystem_09 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_GetCoordinateSystemAsString_10 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_GetReferenceCoordinate_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_GetValue_12 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_GetValue_13 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_GetValue_14 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_GetViewport_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkCoordinate.vtkCoordinate_IsA_16 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkCoordinate.vtkCoordinate_IsTypeOf_17 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_NewInstance_19 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkCoordinate.vtkCoordinate_SafeDownCast_20 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_SetCoordinateSystem_21 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_SetCoordinateSystemToDisplay_22 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_SetCoordinateSystemToNormalizedDisplay_23 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_SetCoordinateSystemToView_25 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_SetCoordinateSystemToViewport_26 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_SetCoordinateSystemToWorld_27 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_SetReferenceCoordinate_28 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_SetValue_29 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_SetValue_30 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_SetValue_31 ( HandleRef  pThis,
double  a,
double  b 
) [private]
static internal void Kitware.VTK.vtkCoordinate.vtkCoordinate_SetViewport_32 ( HandleRef  pThis,
HandleRef  viewport 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkCoordinate.MRClassNameKey = "13vtkCoordinate" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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