Space Engineers
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
VRageMath.BoundingSphereD Struct Reference

Defines a sphere. More...

Inheritance diagram for VRageMath.BoundingSphereD:

Public Member Functions

 BoundingSphereD (Vector3D center, double radius)
 Creates a new instance of BoundingSphereD. More...
 
bool Equals (BoundingSphereD other)
 Determines whether the specified BoundingSphereD is equal to the current BoundingSphereD. More...
 
override bool Equals (object obj)
 Determines whether the specified Object is equal to the BoundingSphereD. More...
 
override int GetHashCode ()
 Gets the hash code for this instance. More...
 
override string ToString ()
 Returns a String that represents the current BoundingSphereD. More...
 
bool Intersects (BoundingBoxD box)
 Checks whether the current BoundingSphereD intersects with a specified BoundingBoxD. More...
 
void Intersects (ref BoundingBoxD box, out bool result)
 Checks whether the current BoundingSphereD intersects a BoundingBoxD. More...
 
double Intersects (RayD ray)
 
bool Intersects (BoundingFrustumD frustum)
 Checks whether the current BoundingSphereD intersects with a specified BoundingFrustum. More...
 
bool Intersects (BoundingSphereD sphere)
 Checks whether the current BoundingSphereD intersects with a specified BoundingSphereD. More...
 
void Intersects (ref BoundingSphereD sphere, out bool result)
 Checks whether the current BoundingSphereD intersects another BoundingSphereD. More...
 
ContainmentType Contains (BoundingBoxD box)
 Checks whether the current BoundingSphereD contains the specified BoundingBoxD. More...
 
void Contains (ref BoundingBoxD box, out ContainmentType result)
 Checks whether the current BoundingSphereD contains the specified BoundingBoxD. More...
 
ContainmentType Contains (BoundingFrustumD frustum)
 Checks whether the current BoundingSphereD contains the specified BoundingFrustum. More...
 
ContainmentType Contains (Vector3D point)
 Checks whether the current BoundingSphereD contains the specified point. More...
 
void Contains (ref Vector3D point, out ContainmentType result)
 Checks whether the current BoundingSphereD contains the specified point. More...
 
ContainmentType Contains (BoundingSphereD sphere)
 Checks whether the current BoundingSphereD contains the specified BoundingSphereD. More...
 
void Contains (ref BoundingSphereD sphere, out ContainmentType result)
 Checks whether the current BoundingSphereD contains the specified BoundingSphereD. More...
 
BoundingSphereD Transform (MatrixD matrix)
 Translates and scales the BoundingSphereD using a given Matrix. More...
 
void Transform (ref MatrixD matrix, out BoundingSphereD result)
 Translates and scales the BoundingSphereD using a given Matrix. More...
 
bool IntersectRaySphere (RayD ray, out double tmin, out double tmax)
 
BoundingSphereD Include (BoundingSphereD sphere)
 

Static Public Member Functions

static bool operator== (BoundingSphereD a, BoundingSphereD b)
 Determines whether two instances of BoundingSphereD are equal. More...
 
static bool operator!= (BoundingSphereD a, BoundingSphereD b)
 Determines whether two instances of BoundingSphereD are not equal. More...
 
static BoundingSphereD CreateMerged (BoundingSphereD original, BoundingSphereD additional)
 Creates a BoundingSphereD that contains the two specified BoundingSphereD instances. More...
 
static void CreateMerged (ref BoundingSphereD original, ref BoundingSphereD additional, out BoundingSphereD result)
 Creates a BoundingSphereD that contains the two specified BoundingSphereD instances. More...
 
static BoundingSphereD CreateFromBoundingBox (BoundingBoxD box)
 Creates the smallest BoundingSphereD that can contain a specified BoundingBoxD. More...
 
static void CreateFromBoundingBox (ref BoundingBoxD box, out BoundingSphereD result)
 Creates the smallest BoundingSphereD that can contain a specified BoundingBoxD. More...
 
static BoundingSphereD CreateFromPoints (Vector3D[] points)
 Creates a BoundingSphereD that can contain a specified list of points. More...
 
static BoundingSphereD CreateFromFrustum (BoundingFrustumD frustum)
 Creates the smallest BoundingSphereD that can contain a specified BoundingFrustum. More...
 
static void Include (ref BoundingSphereD sphere, ref BoundingSphereD otherSphere)
 
static implicit operator BoundingSphereD (BoundingSphere b)
 
static implicit operator BoundingSphere (BoundingSphereD b)
 

Public Attributes

Vector3D Center
 The center point of the sphere. More...
 
double Radius
 The radius of the sphere. More...
 

Detailed Description

Defines a sphere.

Definition at line 11 of file BoundingSphereD.cs.

Constructor & Destructor Documentation

VRageMath.BoundingSphereD.BoundingSphereD ( Vector3D  center,
double  radius 
)
inline

Creates a new instance of BoundingSphereD.

Parameters
centerCenter point of the sphere.
radiusRadius of the sphere.

Definition at line 26 of file BoundingSphereD.cs.

Member Function Documentation

ContainmentType VRageMath.BoundingSphereD.Contains ( BoundingBoxD  box)
inline

Checks whether the current BoundingSphereD contains the specified BoundingBoxD.

Parameters
boxThe BoundingBoxD to check against the current BoundingSphereD.

Definition at line 380 of file BoundingSphereD.cs.

void VRageMath.BoundingSphereD.Contains ( ref BoundingBoxD  box,
out ContainmentType  result 
)
inline

Checks whether the current BoundingSphereD contains the specified BoundingBoxD.

Parameters
boxThe BoundingBoxD to test for overlap.
result[OutAttribute] Enumeration indicating the extent of overlap.

Definition at line 431 of file BoundingSphereD.cs.

ContainmentType VRageMath.BoundingSphereD.Contains ( BoundingFrustumD  frustum)
inline

Checks whether the current BoundingSphereD contains the specified BoundingFrustum.

Parameters
frustumThe BoundingFrustum to check against the current BoundingSphereD.

Definition at line 492 of file BoundingSphereD.cs.

ContainmentType VRageMath.BoundingSphereD.Contains ( Vector3D  point)
inline

Checks whether the current BoundingSphereD contains the specified point.

Parameters
pointThe point to check against the current BoundingSphereD.

Definition at line 513 of file BoundingSphereD.cs.

void VRageMath.BoundingSphereD.Contains ( ref Vector3D  point,
out ContainmentType  result 
)
inline

Checks whether the current BoundingSphereD contains the specified point.

Parameters
pointThe point to test for overlap.
result[OutAttribute] Enumeration indicating the extent of overlap.

Definition at line 522 of file BoundingSphereD.cs.

ContainmentType VRageMath.BoundingSphereD.Contains ( BoundingSphereD  sphere)
inline

Checks whether the current BoundingSphereD contains the specified BoundingSphereD.

Parameters
sphereThe BoundingSphereD to check against the current BoundingSphereD.

Definition at line 533 of file BoundingSphereD.cs.

void VRageMath.BoundingSphereD.Contains ( ref BoundingSphereD  sphere,
out ContainmentType  result 
)
inline

Checks whether the current BoundingSphereD contains the specified BoundingSphereD.

Parameters
sphereThe BoundingSphereD to test for overlap.
result[OutAttribute] Enumeration indicating the extent of overlap.

Definition at line 548 of file BoundingSphereD.cs.

static BoundingSphereD VRageMath.BoundingSphereD.CreateFromBoundingBox ( BoundingBoxD  box)
inlinestatic

Creates the smallest BoundingSphereD that can contain a specified BoundingBoxD.

Parameters
boxThe BoundingBoxD to create the BoundingSphereD from.

Definition at line 160 of file BoundingSphereD.cs.

static void VRageMath.BoundingSphereD.CreateFromBoundingBox ( ref BoundingBoxD  box,
out BoundingSphereD  result 
)
inlinestatic

Creates the smallest BoundingSphereD that can contain a specified BoundingBoxD.

Parameters
boxThe BoundingBoxD to create the BoundingSphereD from.
result[OutAttribute] The created BoundingSphereD.

Definition at line 174 of file BoundingSphereD.cs.

static BoundingSphereD VRageMath.BoundingSphereD.CreateFromFrustum ( BoundingFrustumD  frustum)
inlinestatic

Creates the smallest BoundingSphereD that can contain a specified BoundingFrustum.

Parameters
frustumThe BoundingFrustum to create the BoundingSphereD with.

Definition at line 264 of file BoundingSphereD.cs.

static BoundingSphereD VRageMath.BoundingSphereD.CreateFromPoints ( Vector3D[]  points)
inlinestatic

Creates a BoundingSphereD that can contain a specified list of points.

Parameters
pointsList of points the BoundingSphereD must contain.

Definition at line 186 of file BoundingSphereD.cs.

static BoundingSphereD VRageMath.BoundingSphereD.CreateMerged ( BoundingSphereD  original,
BoundingSphereD  additional 
)
inlinestatic

Creates a BoundingSphereD that contains the two specified BoundingSphereD instances.

Parameters
originalBoundingSphereD to be merged.
additionalBoundingSphereD to be merged.

Definition at line 102 of file BoundingSphereD.cs.

static void VRageMath.BoundingSphereD.CreateMerged ( ref BoundingSphereD  original,
ref BoundingSphereD  additional,
out BoundingSphereD  result 
)
inlinestatic

Creates a BoundingSphereD that contains the two specified BoundingSphereD instances.

Parameters
originalBoundingSphereD to be merged.
additionalBoundingSphereD to be merged.
result[OutAttribute] The created BoundingSphereD.

Definition at line 129 of file BoundingSphereD.cs.

bool VRageMath.BoundingSphereD.Equals ( BoundingSphereD  other)
inline

Determines whether the specified BoundingSphereD is equal to the current BoundingSphereD.

Parameters
otherThe BoundingSphereD to compare with the current BoundingSphereD.

Definition at line 57 of file BoundingSphereD.cs.

override bool VRageMath.BoundingSphereD.Equals ( object  obj)
inline

Determines whether the specified Object is equal to the BoundingSphereD.

Parameters
objThe Object to compare with the current BoundingSphereD.

Definition at line 69 of file BoundingSphereD.cs.

override int VRageMath.BoundingSphereD.GetHashCode ( )
inline

Gets the hash code for this instance.

Definition at line 80 of file BoundingSphereD.cs.

BoundingSphereD VRageMath.BoundingSphereD.Include ( BoundingSphereD  sphere)
inline

Definition at line 616 of file BoundingSphereD.cs.

static void VRageMath.BoundingSphereD.Include ( ref BoundingSphereD  sphere,
ref BoundingSphereD  otherSphere 
)
inlinestatic

Definition at line 622 of file BoundingSphereD.cs.

bool VRageMath.BoundingSphereD.IntersectRaySphere ( RayD  ray,
out double  tmin,
out double  tmax 
)
inline

Definition at line 590 of file BoundingSphereD.cs.

bool VRageMath.BoundingSphereD.Intersects ( BoundingBoxD  box)
inline

Checks whether the current BoundingSphereD intersects with a specified BoundingBoxD.

Parameters
boxThe BoundingBoxD to check for intersection with the current BoundingSphereD.

Definition at line 276 of file BoundingSphereD.cs.

void VRageMath.BoundingSphereD.Intersects ( ref BoundingBoxD  box,
out bool  result 
)
inline

Checks whether the current BoundingSphereD intersects a BoundingBoxD.

Parameters
boxThe BoundingBoxD to check for intersection with.
result[OutAttribute] true if the BoundingSphereD and BoundingBoxD intersect; false otherwise.

Definition at line 289 of file BoundingSphereD.cs.

double VRageMath.BoundingSphereD.Intersects ( RayD  ray)
inline

Definition at line 298 of file BoundingSphereD.cs.

bool VRageMath.BoundingSphereD.Intersects ( BoundingFrustumD  frustum)
inline

Checks whether the current BoundingSphereD intersects with a specified BoundingFrustum.

Parameters
frustumThe BoundingFrustum to check for intersection with the current BoundingSphereD.

Definition at line 307 of file BoundingSphereD.cs.

bool VRageMath.BoundingSphereD.Intersects ( BoundingSphereD  sphere)
inline

Checks whether the current BoundingSphereD intersects with a specified BoundingSphereD.

Parameters
sphereThe BoundingSphereD to check for intersection with the current BoundingSphereD.

Definition at line 354 of file BoundingSphereD.cs.

void VRageMath.BoundingSphereD.Intersects ( ref BoundingSphereD  sphere,
out bool  result 
)
inline

Checks whether the current BoundingSphereD intersects another BoundingSphereD.

Parameters
sphereThe BoundingSphereD to check for intersection with.
result[OutAttribute] true if the BoundingSphereD instances intersect; false otherwise.

Definition at line 367 of file BoundingSphereD.cs.

static implicit VRageMath.BoundingSphereD.operator BoundingSphere ( BoundingSphereD  b)
inlinestatic

Definition at line 660 of file BoundingSphereD.cs.

static implicit VRageMath.BoundingSphereD.operator BoundingSphereD ( BoundingSphere  b)
inlinestatic

Definition at line 655 of file BoundingSphereD.cs.

static bool VRageMath.BoundingSphereD.operator!= ( BoundingSphereD  a,
BoundingSphereD  b 
)
inlinestatic

Determines whether two instances of BoundingSphereD are not equal.

Parameters
aThe BoundingSphereD to the left of the inequality operator.
bThe BoundingSphereD to the right of the inequality operator.

Definition at line 45 of file BoundingSphereD.cs.

static bool VRageMath.BoundingSphereD.operator== ( BoundingSphereD  a,
BoundingSphereD  b 
)
inlinestatic

Determines whether two instances of BoundingSphereD are equal.

Parameters
aThe object to the left of the equality operator.
bThe object to the right of the equality operator.

Definition at line 36 of file BoundingSphereD.cs.

override string VRageMath.BoundingSphereD.ToString ( )
inline

Returns a String that represents the current BoundingSphereD.

Definition at line 88 of file BoundingSphereD.cs.

BoundingSphereD VRageMath.BoundingSphereD.Transform ( MatrixD  matrix)
inline

Translates and scales the BoundingSphereD using a given Matrix.

Parameters
matrixA transformation matrix that might include translation, rotation, or uniform scaling. Note that BoundingSphereD.Transform will not return correct results if there are non-uniform scaling, shears, or other unusual transforms in this transformation matrix. This is because there is no way to shear or non-uniformly scale a sphere. Such an operation would cause the sphere to lose its shape as a sphere.

Definition at line 569 of file BoundingSphereD.cs.

void VRageMath.BoundingSphereD.Transform ( ref MatrixD  matrix,
out BoundingSphereD  result 
)
inline

Translates and scales the BoundingSphereD using a given Matrix.

Parameters
matrixA transformation matrix that might include translation, rotation, or uniform scaling. Note that BoundingSphereD.Transform will not return correct results if there are non-uniform scaling, shears, or other unusual transforms in this transformation matrix. This is because there is no way to shear or non-uniformly scale a sphere. Such an operation would cause the sphere to lose its shape as a sphere.
result[OutAttribute] The transformed BoundingSphereD.

Definition at line 582 of file BoundingSphereD.cs.

Member Data Documentation

Vector3D VRageMath.BoundingSphereD.Center

The center point of the sphere.

Definition at line 16 of file BoundingSphereD.cs.

double VRageMath.BoundingSphereD.Radius

The radius of the sphere.

Definition at line 20 of file BoundingSphereD.cs.


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