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

vtkBox - implicit function for a bounding box More...

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

List of all members.

Public Member Functions

 vtkBox (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkBox ()
 Description Construct box with center at (0,0,0) and each side of length 1.0.
void AddBounds (IntPtr bounds)
 A special method that allows union set operation on bounding boxes. Start with a SetBounds(). Subsequent AddBounds() methods are union set operations on the original bounds. Retrieve the final bounds with a GetBounds() method.
override double EvaluateFunction (IntPtr x)
 Description Evaluate box defined by the two points (pMin,pMax).
new double EvaluateFunction (double x, double y, double z)
 Description Evaluate box defined by the two points (pMin,pMax).
override void EvaluateGradient (IntPtr x, IntPtr n)
 Description Evaluate the gradient of the box.
void GetBounds (ref double xMin, ref double xMax, ref double yMin, ref double yMax, ref double zMin, ref double zMax)
 Set / get the bounding box using various methods.
void GetBounds (IntPtr bounds)
 Set / get the bounding box using various methods.
IntPtr GetBounds ()
 Set / get the bounding box using various methods.
void GetXMax (IntPtr p)
 Set / get the bounding box using various methods.
void GetXMax (ref double x, ref double y, ref double z)
 Set / get the bounding box using various methods.
void GetXMin (IntPtr p)
 Set / get the bounding box using various methods.
void GetXMin (ref double x, ref double y, ref double z)
 Set / get the bounding box using various methods.
override int IsA (string type)
 Undocumented Block.
new vtkBox NewInstance ()
 Undocumented Block.
void SetBounds (double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
 Set / get the bounding box using various methods.
void SetBounds (IntPtr bounds)
 Set / get the bounding box using various methods.
void SetXMax (IntPtr p)
 Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.
void SetXMax (double x, double y, double z)
 Set / get the bounding box using various methods.
void SetXMin (IntPtr p)
 Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.
void SetXMin (double x, double y, double z)
 Set / get the bounding box using various methods.

Static Public Member Functions

static new vtkBox New ()
 Description Construct box with center at (0,0,0) and each side of length 1.0.
static sbyte IntersectBox (IntPtr bounds, IntPtr origin, IntPtr dir, IntPtr coord, ref double t)
 Bounding box intersection modified from Graphics Gems Vol I. The method returns a non-zero value if the bounding box is hit. Origin[3] starts the ray, dir[3] is the vector components of the ray in the x-y-z directions, coord[3] is the location of hit, and t is the parametric coordinate along line. (Notes: the intersection ray dir[3] is NOT normalized. Valid intersections will only occur between 0<=t<=1.)
static int IntersectWithLine (IntPtr bounds, IntPtr p1, IntPtr p2, ref double t1, ref double t2, IntPtr x1, IntPtr x2, ref int plane1, ref int plane2)
 Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkBox SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "6vtkBox"
 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 vtkBox_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBox_AddBounds_01 (HandleRef pThis, IntPtr bounds)
static internal double vtkBox_EvaluateFunction_02 (HandleRef pThis, IntPtr x)
static internal double vtkBox_EvaluateFunction_03 (HandleRef pThis, double x, double y, double z)
static internal void vtkBox_EvaluateGradient_04 (HandleRef pThis, IntPtr x, IntPtr n)
static internal void vtkBox_GetBounds_05 (HandleRef pThis, ref double xMin, ref double xMax, ref double yMin, ref double yMax, ref double zMin, ref double zMax)
static internal void vtkBox_GetBounds_06 (HandleRef pThis, IntPtr bounds)
static internal IntPtr vtkBox_GetBounds_07 (HandleRef pThis)
static internal void vtkBox_GetXMax_08 (HandleRef pThis, IntPtr p)
static internal void vtkBox_GetXMax_09 (HandleRef pThis, ref double x, ref double y, ref double z)
static internal void vtkBox_GetXMin_10 (HandleRef pThis, IntPtr p)
static internal void vtkBox_GetXMin_11 (HandleRef pThis, ref double x, ref double y, ref double z)
static internal sbyte vtkBox_IntersectBox_12 (IntPtr bounds, IntPtr origin, IntPtr dir, IntPtr coord, ref double t)
static internal int vtkBox_IntersectWithLine_13 (IntPtr bounds, IntPtr p1, IntPtr p2, ref double t1, ref double t2, IntPtr x1, IntPtr x2, ref int plane1, ref int plane2)
static internal int vtkBox_IsA_14 (HandleRef pThis, string type)
static internal int vtkBox_IsTypeOf_15 (string type)
static internal IntPtr vtkBox_NewInstance_17 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkBox_SafeDownCast_18 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBox_SetBounds_19 (HandleRef pThis, double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
static internal void vtkBox_SetBounds_20 (HandleRef pThis, IntPtr bounds)
static internal void vtkBox_SetXMax_21 (HandleRef pThis, IntPtr p)
static internal void vtkBox_SetXMax_22 (HandleRef pThis, double x, double y, double z)
static internal void vtkBox_SetXMin_23 (HandleRef pThis, IntPtr p)
static internal void vtkBox_SetXMin_24 (HandleRef pThis, double x, double y, double z)

Static Private Member Functions

static vtkBox ()
 Automatically generated type registration mechanics.

Detailed Description

vtkBox - implicit function for a bounding box

Description vtkBox computes the implicit function and/or gradient for a axis-aligned bounding box. (The superclasses transform can be used to modify this orientation.) Each side of the box is orthogonal to all other sides meeting along shared edges and all faces are orthogonal to the x-y-z coordinate axes. (If you wish to orient this box differently, recall that the superclass vtkImplicitFunction supports a transformation matrix.) vtkCube is a concrete implementation of vtkImplicitFunction.

vtkCubeSource vtkImplicitFunction


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Description Construct box with center at (0,0,0) and each side of length 1.0.


Member Function Documentation

void Kitware.VTK.vtkBox.AddBounds ( IntPtr  bounds)

A special method that allows union set operation on bounding boxes. Start with a SetBounds(). Subsequent AddBounds() methods are union set operations on the original bounds. Retrieve the final bounds with a GetBounds() method.

override void Kitware.VTK.vtkBox.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.vtkImplicitFunction.

override double Kitware.VTK.vtkBox.EvaluateFunction ( IntPtr  x) [virtual]

Description Evaluate box defined by the two points (pMin,pMax).

Reimplemented from Kitware.VTK.vtkImplicitFunction.

new double Kitware.VTK.vtkBox.EvaluateFunction ( double  x,
double  y,
double  z 
)

Description Evaluate box defined by the two points (pMin,pMax).

Reimplemented from Kitware.VTK.vtkImplicitFunction.

override void Kitware.VTK.vtkBox.EvaluateGradient ( IntPtr  x,
IntPtr  n 
) [virtual]

Description Evaluate the gradient of the box.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

void Kitware.VTK.vtkBox.GetBounds ( ref double  xMin,
ref double  xMax,
ref double  yMin,
ref double  yMax,
ref double  zMin,
ref double  zMax 
)

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.GetBounds ( IntPtr  bounds)

Set / get the bounding box using various methods.

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.GetXMax ( IntPtr  p)

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.GetXMax ( ref double  x,
ref double  y,
ref double  z 
)

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.GetXMin ( IntPtr  p)

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.GetXMin ( ref double  x,
ref double  y,
ref double  z 
)

Set / get the bounding box using various methods.

static sbyte Kitware.VTK.vtkBox.IntersectBox ( IntPtr  bounds,
IntPtr  origin,
IntPtr  dir,
IntPtr  coord,
ref double  t 
) [static]

Bounding box intersection modified from Graphics Gems Vol I. The method returns a non-zero value if the bounding box is hit. Origin[3] starts the ray, dir[3] is the vector components of the ray in the x-y-z directions, coord[3] is the location of hit, and t is the parametric coordinate along line. (Notes: the intersection ray dir[3] is NOT normalized. Valid intersections will only occur between 0<=t<=1.)

static int Kitware.VTK.vtkBox.IntersectWithLine ( IntPtr  bounds,
IntPtr  p1,
IntPtr  p2,
ref double  t1,
ref double  t2,
IntPtr  x1,
IntPtr  x2,
ref int  plane1,
ref int  plane2 
) [static]

Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

static new vtkBox Kitware.VTK.vtkBox.New ( ) [static]

Description Construct box with center at (0,0,0) and each side of length 1.0.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Here is the call graph for this function:

void Kitware.VTK.vtkBox.SetBounds ( double  xMin,
double  xMax,
double  yMin,
double  yMax,
double  zMin,
double  zMax 
)

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.SetBounds ( IntPtr  bounds)

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.SetXMax ( IntPtr  p)

Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.

void Kitware.VTK.vtkBox.SetXMax ( double  x,
double  y,
double  z 
)

Set / get the bounding box using various methods.

void Kitware.VTK.vtkBox.SetXMin ( IntPtr  p)

Intersect a line with the box. Give the endpoints of the line in p1 and p2. The parameteric distances from p1 to the entry and exit points are returned in t1 and t2, where t1 and t2 are clamped to the range [0,1]. The entry and exit planes are returned in plane1 and plane2 where integers (0, 1, 2, 3, 4, 5) stand for the (xmin, xmax, ymin, ymax, zmin, zmax) planes respectively, and a value of -1 means that no intersection occurred. The actual intersection coordinates are stored in x1 and x2, which can be set to NULL of you do not need them to be returned. The function return value will be zero if the line is wholly outside of the box.

void Kitware.VTK.vtkBox.SetXMin ( double  x,
double  y,
double  z 
)

Set / get the bounding box using various methods.

static internal void Kitware.VTK.vtkBox.vtkBox_AddBounds_01 ( HandleRef  pThis,
IntPtr  bounds 
) [private]
static internal double Kitware.VTK.vtkBox.vtkBox_EvaluateFunction_02 ( HandleRef  pThis,
IntPtr  x 
) [private]
static internal double Kitware.VTK.vtkBox.vtkBox_EvaluateFunction_03 ( HandleRef  pThis,
double  x,
double  y,
double  z 
) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_EvaluateGradient_04 ( HandleRef  pThis,
IntPtr  x,
IntPtr  n 
) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_GetBounds_05 ( HandleRef  pThis,
ref double  xMin,
ref double  xMax,
ref double  yMin,
ref double  yMax,
ref double  zMin,
ref double  zMax 
) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_GetBounds_06 ( HandleRef  pThis,
IntPtr  bounds 
) [private]
static internal IntPtr Kitware.VTK.vtkBox.vtkBox_GetBounds_07 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_GetXMax_08 ( HandleRef  pThis,
IntPtr  p 
) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_GetXMax_09 ( HandleRef  pThis,
ref double  x,
ref double  y,
ref double  z 
) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_GetXMin_10 ( HandleRef  pThis,
IntPtr  p 
) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_GetXMin_11 ( HandleRef  pThis,
ref double  x,
ref double  y,
ref double  z 
) [private]
static internal sbyte Kitware.VTK.vtkBox.vtkBox_IntersectBox_12 ( IntPtr  bounds,
IntPtr  origin,
IntPtr  dir,
IntPtr  coord,
ref double  t 
) [private]
static internal int Kitware.VTK.vtkBox.vtkBox_IntersectWithLine_13 ( IntPtr  bounds,
IntPtr  p1,
IntPtr  p2,
ref double  t1,
ref double  t2,
IntPtr  x1,
IntPtr  x2,
ref int  plane1,
ref int  plane2 
) [private]
static internal int Kitware.VTK.vtkBox.vtkBox_IsA_14 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkBox.vtkBox_IsTypeOf_15 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkBox.vtkBox_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkBox.vtkBox_NewInstance_17 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkBox.vtkBox_SafeDownCast_18 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_SetBounds_19 ( HandleRef  pThis,
double  xMin,
double  xMax,
double  yMin,
double  yMax,
double  zMin,
double  zMax 
) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_SetBounds_20 ( HandleRef  pThis,
IntPtr  bounds 
) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_SetXMax_21 ( HandleRef  pThis,
IntPtr  p 
) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_SetXMax_22 ( HandleRef  pThis,
double  x,
double  y,
double  z 
) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_SetXMin_23 ( HandleRef  pThis,
IntPtr  p 
) [private]
static internal void Kitware.VTK.vtkBox.vtkBox_SetXMin_24 ( HandleRef  pThis,
double  x,
double  y,
double  z 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkBox.MRClassNameKey = "6vtkBox" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImplicitFunction.


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