Inheritance diagram for VRageMath.PlaneD:

Public Member Functions
	PlaneD (double a, double b, double c, double d)
	Creates a new instance of PlaneD. More...

	PlaneD (Vector3D normal, double d)
	Creates a new instance of PlaneD. More...

	PlaneD (Vector3D position, Vector3D normal)
	Creates a new instance of Plane. More...

	PlaneD (Vector3D position, Vector3 normal)
	Creates a new instance of Plane. More...

	PlaneD (Vector4 value)
	Creates a new instance of PlaneD. More...

	PlaneD (Vector3D point1, Vector3D point2, Vector3D point3)
	Creates a new instance of PlaneD. More...

bool	Equals (PlaneD other)
	Determines whether the specified PlaneD is equal to the PlaneD. More...

override bool	Equals (object obj)
	Determines whether the specified Object is equal to the PlaneD. More...

override int	GetHashCode ()
	Gets the hash code for this object. More...

override string	ToString ()
	Returns a String that represents the current PlaneD. More...

void	Normalize ()
	Changes the coefficients of the Normal vector of this PlaneD to make it of unit length. More...

double	Dot (Vector4 value)
	Calculates the dot product of a specified Vector4 and this PlaneD. More...

void	Dot (ref Vector4 value, out double result)
	Calculates the dot product of a specified Vector4 and this PlaneD. More...

double	DotCoordinate (Vector3D value)
	Returns the dot product of a specified Vector3D and the Normal vector of this PlaneD plus the distance (D) value of the PlaneD. More...

void	DotCoordinate (ref Vector3D value, out double result)
	Returns the dot product of a specified Vector3D and the Normal vector of this PlaneD plus the distance (D) value of the PlaneD. More...

double	DotNormal (Vector3D value)
	Returns the dot product of a specified Vector3D and the Normal vector of this PlaneD. More...

void	DotNormal (ref Vector3D value, out double result)
	Returns the dot product of a specified Vector3D and the Normal vector of this PlaneD. More...

PlaneIntersectionType	Intersects (BoundingBoxD box)
	Checks whether the current PlaneD intersects a specified BoundingBox. More...

void	Intersects (ref BoundingBoxD box, out PlaneIntersectionType result)
	Checks whether the current PlaneD intersects a BoundingBox. More...

PlaneIntersectionType	Intersects (BoundingFrustumD frustum)
	Checks whether the current PlaneD intersects a specified BoundingFrustum. More...

PlaneIntersectionType	Intersects (BoundingSphereD sphere)
	Checks whether the current PlaneD intersects a specified BoundingSphere. More...

void	Intersects (ref BoundingSphere sphere, out PlaneIntersectionType result)
	Checks whether the current PlaneD intersects a BoundingSphere. More...

Vector3D	RandomPoint ()

double	DistanceToPoint (Vector3D point)

double	DistanceToPoint (ref Vector3D point)

Vector3D	ProjectPoint (ref Vector3D point)

Vector3D	Intersection (ref Vector3D from, ref Vector3D direction)
	Gets intersection point in Plane. More...

Static Public Member Functions
static bool	operator== (PlaneD lhs, PlaneD rhs)
	Determines whether two instances of PlaneD are equal. More...

static bool	operator!= (PlaneD lhs, PlaneD rhs)
	Determines whether two instances of PlaneD are not equal. More...

static PlaneD	Normalize (PlaneD value)
	Changes the coefficients of the Normal vector of a PlaneD to make it of unit length. More...

static void	Normalize (ref PlaneD value, out PlaneD result)
	Changes the coefficients of the Normal vector of a PlaneD to make it of unit length. More...

static PlaneD	Transform (PlaneD plane, MatrixD matrix)
	Transforms a normalized PlaneD by a Matrix. More...

static void	Transform (ref PlaneD plane, ref MatrixD matrix, out PlaneD result)
	Transforms a normalized PlaneD by a Matrix. More...

Public Attributes
Vector3D	Normal
	The normal vector of the PlaneD. More...

double	D
	The distance of the PlaneD along its normal from the origin. Note: Be careful! The distance is signed and is the opposite of what people usually expect. If you look closely at the plane equation: (n dot P) + D = 0, you'll realize that D = - (n dot P) (that is, negative instead of positive) More...

Static Public Attributes
static System.Random	_random

Detailed Description

Defines a PlaneD.

Definition at line 10 of file PlaneD.cs.

Constructor & Destructor Documentation

VRageMath.PlaneD.PlaneD	(	double	a,
		double	b,
		double	c,
		double	d
	)

inline

Creates a new instance of PlaneD.

Parameters

a	X component of the normal defining the PlaneD.
b	Y component of the normal defining the PlaneD.
c	Z component of the normal defining the PlaneD.
d	Distance of the origin from the PlaneD along its normal.

Definition at line 27 of file PlaneD.cs.

VRageMath.PlaneD.PlaneD	(	Vector3D	normal,
		double	d
	)

inline

Creates a new instance of PlaneD.

Parameters

normal	The normal vector to the PlaneD.
d	The distance of the origin from the PlaneD along its normal.

Definition at line 39 of file PlaneD.cs.

VRageMath.PlaneD.PlaneD	(	Vector3D	position,
		Vector3D	normal
	)

inline

Creates a new instance of Plane.

Parameters

position	A point that lies on the Plane
normal	The normal vector to the Plane.

Definition at line 49 of file PlaneD.cs.

VRageMath.PlaneD.PlaneD	(	Vector3D	position,
		Vector3	normal
	)

inline

Creates a new instance of Plane.

Parameters

position	A point that lies on the Plane
normal	The normal vector to the Plane.

Definition at line 60 of file PlaneD.cs.

VRageMath.PlaneD.PlaneD ( Vector4 value )

inline

Creates a new instance of PlaneD.

Parameters

value Vector4 with X, Y, and Z components defining the normal of the PlaneD. The W component defines the distance of the origin from the PlaneD along its normal.

Definition at line 71 of file PlaneD.cs.

VRageMath.PlaneD.PlaneD	(	Vector3D	point1,
		Vector3D	point2,
		Vector3D	point3
	)

inline

Creates a new instance of PlaneD.

Parameters

point1	One point of a triangle defining the PlaneD.
point2	One point of a triangle defining the PlaneD.
point3	One point of a triangle defining the PlaneD.

Definition at line 83 of file PlaneD.cs.

Member Function Documentation

double VRageMath.PlaneD.DistanceToPoint ( Vector3D point )

inline

Definition at line 421 of file PlaneD.cs.

double VRageMath.PlaneD.DistanceToPoint ( ref Vector3D point )

inline

Definition at line 427 of file PlaneD.cs.

double VRageMath.PlaneD.Dot ( Vector4 value )

inline

Calculates the dot product of a specified Vector4 and this PlaneD.

Parameters

value The Vector4 to multiply this PlaneD by.

Definition at line 259 of file PlaneD.cs.

void VRageMath.PlaneD.Dot	(	ref Vector4	value,
		out double	result
	)

inline

Calculates the dot product of a specified Vector4 and this PlaneD.

Parameters

value	The Vector4 to multiply this PlaneD by.
result	[OutAttribute] The dot product of the specified Vector4 and this PlaneD.

Definition at line 268 of file PlaneD.cs.

double VRageMath.PlaneD.DotCoordinate ( Vector3D value )

inline

Returns the dot product of a specified Vector3D and the Normal vector of this PlaneD plus the distance (D) value of the PlaneD.

Parameters

value The Vector3D to multiply by.

Definition at line 277 of file PlaneD.cs.

void VRageMath.PlaneD.DotCoordinate	(	ref Vector3D	value,
		out double	result
	)

inline

Returns the dot product of a specified Vector3D and the Normal vector of this PlaneD plus the distance (D) value of the PlaneD.

Parameters

value	The Vector3D to multiply by.
result	[OutAttribute] The resulting value.

Definition at line 286 of file PlaneD.cs.

double VRageMath.PlaneD.DotNormal ( Vector3D value )

inline

Returns the dot product of a specified Vector3D and the Normal vector of this PlaneD.

Parameters

value The Vector3D to multiply by.

Definition at line 295 of file PlaneD.cs.

void VRageMath.PlaneD.DotNormal	(	ref Vector3D	value,
		out double	result
	)

inline

Returns the dot product of a specified Vector3D and the Normal vector of this PlaneD.

Parameters

value	The Vector3D to multiply by.
result	[OutAttribute] The resulting dot product.

Definition at line 304 of file PlaneD.cs.

bool VRageMath.PlaneD.Equals ( PlaneD other )

inline

Determines whether the specified PlaneD is equal to the PlaneD.

Parameters

other The PlaneD to compare with the current PlaneD.

Definition at line 126 of file PlaneD.cs.

override bool VRageMath.PlaneD.Equals ( object obj )

inline

Determines whether the specified Object is equal to the PlaneD.

Parameters

obj	The Object to compare with the current PlaneD.

Definition at line 138 of file PlaneD.cs.

override int VRageMath.PlaneD.GetHashCode ( )

inline

Gets the hash code for this object.

Definition at line 149 of file PlaneD.cs.

Vector3D VRageMath.PlaneD.Intersection	(	ref Vector3D	from,
		ref Vector3D	direction
	)

inline

Gets intersection point in Plane.

Parameters

from	Starting point of a ray.
direction	Ray direction.

Returns: Point of intersection.

Definition at line 444 of file PlaneD.cs.

PlaneIntersectionType VRageMath.PlaneD.Intersects ( BoundingBoxD box )

inline

Checks whether the current PlaneD intersects a specified BoundingBox.

Parameters

box	The BoundingBox to test for intersection with.

Definition at line 313 of file PlaneD.cs.

void VRageMath.PlaneD.Intersects	(	ref BoundingBoxD	box,
		out PlaneIntersectionType	result
	)

inline

Checks whether the current PlaneD intersects a BoundingBox.

Parameters

box	The BoundingBox to check for intersection with.
result	[OutAttribute] An enumeration indicating whether the PlaneD intersects the BoundingBox.

Definition at line 332 of file PlaneD.cs.

PlaneIntersectionType VRageMath.PlaneD.Intersects ( BoundingFrustumD frustum )

inline

Checks whether the current PlaneD intersects a specified BoundingFrustum.

Parameters

frustum The BoundingFrustum to check for intersection with.

Definition at line 354 of file PlaneD.cs.

PlaneIntersectionType VRageMath.PlaneD.Intersects ( BoundingSphereD sphere )

inline

Checks whether the current PlaneD intersects a specified BoundingSphere.

Parameters

sphere The BoundingSphere to check for intersection with.

Definition at line 363 of file PlaneD.cs.

void VRageMath.PlaneD.Intersects	(	ref BoundingSphere	sphere,
		out PlaneIntersectionType	result
	)

inline

Checks whether the current PlaneD intersects a BoundingSphere.

Parameters

sphere	The BoundingSphere to check for intersection with.
result	[OutAttribute] An enumeration indicating whether the PlaneD intersects the BoundingSphere.

Definition at line 375 of file PlaneD.cs.

void VRageMath.PlaneD.Normalize ( )

inline

Changes the coefficients of the Normal vector of this PlaneD to make it of unit length.

Definition at line 170 of file PlaneD.cs.

static PlaneD VRageMath.PlaneD.Normalize ( PlaneD value )

inlinestatic

Changes the coefficients of the Normal vector of a PlaneD to make it of unit length.

Parameters

value The PlaneD to normalize.

Definition at line 186 of file PlaneD.cs.

static void VRageMath.PlaneD.Normalize	(	ref PlaneD	value,
		out PlaneD	result
	)

inlinestatic

Changes the coefficients of the Normal vector of a PlaneD to make it of unit length.

Parameters

value	The PlaneD to normalize.
result	[OutAttribute] An existing PlaneD PlaneD filled in with a normalized version of the specified PlaneD.

Definition at line 212 of file PlaneD.cs.

static bool VRageMath.PlaneD.operator!=	(	PlaneD	lhs,
		PlaneD	rhs
	)

inlinestatic

Determines whether two instances of PlaneD are not equal.

Parameters

lhs	The object to the left of the inequality operator.
rhs	The object to the right of the inequality operator.

Definition at line 114 of file PlaneD.cs.

static bool VRageMath.PlaneD.operator==	(	PlaneD	lhs,
		PlaneD	rhs
	)

inlinestatic

Determines whether two instances of PlaneD are equal.

Parameters

lhs	The object to the left of the equality operator.
rhs	The object to the right of the equality operator.

Definition at line 105 of file PlaneD.cs.

Vector3D VRageMath.PlaneD.ProjectPoint ( ref Vector3D point )

inline

Definition at line 433 of file PlaneD.cs.

Vector3D VRageMath.PlaneD.RandomPoint ( )

inline

Definition at line 390 of file PlaneD.cs.

override string VRageMath.PlaneD.ToString ( )

inline

Returns a String that represents the current PlaneD.

Definition at line 157 of file PlaneD.cs.

static PlaneD VRageMath.PlaneD.Transform	(	PlaneD	plane,
		MatrixD	matrix
	)

inlinestatic

Transforms a normalized PlaneD by a Matrix.

Parameters

PlaneD	The normalized PlaneD to transform. This PlaneD must already be normalized, so that its Normal vector is of unit length, before this method is called.
matrix	The transform Matrix to apply to the PlaneD.

Definition at line 234 of file PlaneD.cs.

static void VRageMath.PlaneD.Transform	(	ref PlaneD	plane,
		ref MatrixD	matrix,
		out PlaneD	result
	)

inlinestatic

Transforms a normalized PlaneD by a Matrix.

Parameters

PlaneD	The normalized PlaneD to transform. This PlaneD must already be normalized, so that its Normal vector is of unit length, before this method is called.
matrix	The transform Matrix to apply to the PlaneD.
result	[OutAttribute] An existing PlaneD filled in with the results of applying the transform.

Definition at line 245 of file PlaneD.cs.

Member Data Documentation

System.Random VRageMath.PlaneD._random

static

Definition at line 386 of file PlaneD.cs.

double VRageMath.PlaneD.D

The distance of the PlaneD along its normal from the origin. Note: Be careful! The distance is signed and is the opposite of what people usually expect. If you look closely at the plane equation: (n dot P) + D = 0, you'll realize that D = - (n dot P) (that is, negative instead of positive)

Definition at line 21 of file PlaneD.cs.

Vector3D VRageMath.PlaneD.Normal

The normal vector of the PlaneD.

Definition at line 15 of file PlaneD.cs.

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

Sources/VRage.Math/PlaneD.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation