BoundingSphere¶
-
struct
BoundingSphere
: System.ValueType, System.IEquatable<BoundingSphere> Describes a sphere in 3D-space for bounding operations.
-
Vector3
Center
The sphere center.
-
float
Radius
The sphere radius.
-
string
get_DebugDisplayString
()
-
ContainmentType
Contains
(BoundingBox box) Test if a bounding box is fully inside, outside, or just intersecting the sphere.
Parameters: - box (Microsoft.Xna.Framework.BoundingBox) – The box for testing.
Returns: The containment type.
-
void
Contains
(ref BoundingBox box, ref ContainmentType result) Parameters: - (ref) box (Microsoft.Xna.Framework.BoundingBox) –
- (ref) result (Microsoft.Xna.Framework.ContainmentType) –
-
ContainmentType
Contains
(BoundingFrustum frustum) Test if a frustum is fully inside, outside, or just intersecting the sphere.
Parameters: - frustum (Microsoft.Xna.Framework.BoundingFrustum) – The frustum for testing.
Returns: The containment type.
-
void
Contains
(ref BoundingFrustum frustum, ref ContainmentType result) Parameters: - (ref) frustum (Microsoft.Xna.Framework.BoundingFrustum) –
- (ref) result (Microsoft.Xna.Framework.ContainmentType) –
-
ContainmentType
Contains
(BoundingSphere sphere) Test if a sphere is fully inside, outside, or just intersecting the sphere.
Parameters: - sphere (Microsoft.Xna.Framework.BoundingSphere) – The other sphere for testing.
Returns: The containment type.
-
void
Contains
(ref BoundingSphere sphere, ref ContainmentType result) Parameters: - (ref) sphere (Microsoft.Xna.Framework.BoundingSphere) –
- (ref) result (Microsoft.Xna.Framework.ContainmentType) –
-
ContainmentType
Contains
(Vector3 point) Test if a point is fully inside, outside, or just intersecting the sphere.
Parameters: - point (Microsoft.Xna.Framework.Vector3) – The vector in 3D-space for testing.
Returns: The containment type.
-
void
Contains
(ref Vector3 point, ref ContainmentType result) Parameters: - (ref) point (Microsoft.Xna.Framework.Vector3) –
- (ref) result (Microsoft.Xna.Framework.ContainmentType) –
-
BoundingSphere
CreateFromBoundingBox
(BoundingBox box) Creates the smallest T:Microsoft.Xna.Framework.BoundingSphere that can contain a specified T:Microsoft.Xna.Framework.BoundingBox.
Parameters: - box (Microsoft.Xna.Framework.BoundingBox) – The box to create the sphere from.
Returns: The new T:Microsoft.Xna.Framework.BoundingSphere.
-
void
CreateFromBoundingBox
(ref BoundingBox box, ref BoundingSphere result) Parameters: - (ref) box (Microsoft.Xna.Framework.BoundingBox) –
- (ref) result (Microsoft.Xna.Framework.BoundingSphere) –
-
BoundingSphere
CreateFromFrustum
(BoundingFrustum frustum) Creates the smallest T:Microsoft.Xna.Framework.BoundingSphere that can contain a specified T:Microsoft.Xna.Framework.BoundingFrustum.
Parameters: - frustum (Microsoft.Xna.Framework.BoundingFrustum) – The frustum to create the sphere from.
Returns: The new T:Microsoft.Xna.Framework.BoundingSphere.
-
BoundingSphere
CreateFromPoints
(System.Collections.Generic.IEnumerable<Vector3> points) Creates the smallest T:Microsoft.Xna.Framework.BoundingSphere that can contain a specified list of points in 3D-space.
Parameters: - points (System.Collections.Generic.IEnumerable<Vector3>) – List of point to create the sphere from.
Returns: The new T:Microsoft.Xna.Framework.BoundingSphere.
-
BoundingSphere
CreateMerged
(BoundingSphere original, BoundingSphere additional) Creates the smallest T:Microsoft.Xna.Framework.BoundingSphere that can contain two spheres.
Parameters: - original (Microsoft.Xna.Framework.BoundingSphere) – First sphere.
- additional (Microsoft.Xna.Framework.BoundingSphere) – Second sphere.
Returns: The new T:Microsoft.Xna.Framework.BoundingSphere.
-
void
CreateMerged
(ref BoundingSphere original, ref BoundingSphere additional, ref BoundingSphere result) Parameters: - (ref) original (Microsoft.Xna.Framework.BoundingSphere) –
- (ref) additional (Microsoft.Xna.Framework.BoundingSphere) –
- (ref) result (Microsoft.Xna.Framework.BoundingSphere) –
-
bool
Equals
(BoundingSphere other) Compares whether current instance is equal to specified T:Microsoft.Xna.Framework.BoundingSphere.
Parameters: - other (Microsoft.Xna.Framework.BoundingSphere) – The T:Microsoft.Xna.Framework.BoundingSphere to compare.
Returns: true if the instances are equal; false otherwise.
-
bool
Equals
(System.Object obj) Compares whether current instance is equal to specified T:System.Object.
Parameters: - obj (System.Object) – The T:System.Object to compare.
Returns: true if the instances are equal; false otherwise.
-
int
GetHashCode
() Gets the hash code of this T:Microsoft.Xna.Framework.BoundingSphere.
Returns: Hash code of this T:Microsoft.Xna.Framework.BoundingSphere.
-
bool
Intersects
(BoundingBox box) Gets whether or not a specified T:Microsoft.Xna.Framework.BoundingBox intersects with this sphere.
Parameters: - box (Microsoft.Xna.Framework.BoundingBox) – The box for testing.
Returns: true if T:Microsoft.Xna.Framework.BoundingBox intersects with this sphere; false otherwise.
-
void
Intersects
(ref BoundingBox box, ref bool result) Parameters: - (ref) box (Microsoft.Xna.Framework.BoundingBox) –
- (ref) result (bool) –
-
bool
Intersects
(BoundingSphere sphere) Gets whether or not the other T:Microsoft.Xna.Framework.BoundingSphere intersects with this sphere.
Parameters: - sphere (Microsoft.Xna.Framework.BoundingSphere) – The other sphere for testing.
Returns: true if other T:Microsoft.Xna.Framework.BoundingSphere intersects with this sphere; false otherwise.
-
void
Intersects
(ref BoundingSphere sphere, ref bool result) Parameters: - (ref) sphere (Microsoft.Xna.Framework.BoundingSphere) –
- (ref) result (bool) –
-
PlaneIntersectionType
Intersects
(Plane plane) Gets whether or not a specified T:Microsoft.Xna.Framework.Plane intersects with this sphere.
Parameters: - plane (Microsoft.Xna.Framework.Plane) – The plane for testing.
Returns: Type of intersection.
-
void
Intersects
(ref Plane plane, ref PlaneIntersectionType result) Parameters: - (ref) plane (Microsoft.Xna.Framework.Plane) –
- (ref) result (Microsoft.Xna.Framework.PlaneIntersectionType) –
-
System.Nullable<Single>
Intersects
(Ray ray) Gets whether or not a specified T:Microsoft.Xna.Framework.Ray intersects with this sphere.
Parameters: - ray (Microsoft.Xna.Framework.Ray) – The ray for testing.
Returns: Distance of ray intersection or null if there is no intersection.
-
void
Intersects
(ref Ray ray, ref System.Nullable<Single> result) Parameters: - (ref) ray (Microsoft.Xna.Framework.Ray) –
- (ref) result (System.Nullable<Single>) –
-
string
ToString
() Returns a T:System.String representation of this T:Microsoft.Xna.Framework.BoundingSphere in the format: {Center:[F:Microsoft.Xna.Framework.BoundingSphere.Center] Radius:[F:Microsoft.Xna.Framework.BoundingSphere.Radius]}
Returns: A T:System.String representation of this T:Microsoft.Xna.Framework.BoundingSphere.
-
BoundingSphere
Transform
(Matrix matrix) Creates a new T:Microsoft.Xna.Framework.BoundingSphere that contains a transformation of translation and scale from this sphere by the specified T:Microsoft.Xna.Framework.Matrix.
Parameters: - matrix (Microsoft.Xna.Framework.Matrix) – The transformation T:Microsoft.Xna.Framework.Matrix.
Returns: Transformed T:Microsoft.Xna.Framework.BoundingSphere.
-
void
Transform
(ref Matrix matrix, ref BoundingSphere result) Parameters: - (ref) matrix (Microsoft.Xna.Framework.Matrix) –
- (ref) result (Microsoft.Xna.Framework.BoundingSphere) –
-
bool
op_Equality
(BoundingSphere a, BoundingSphere b) Compares whether two T:Microsoft.Xna.Framework.BoundingSphere instances are equal.
Parameters: - a (Microsoft.Xna.Framework.BoundingSphere) – T:Microsoft.Xna.Framework.BoundingSphere instance on the left of the equal sign.
- b (Microsoft.Xna.Framework.BoundingSphere) – T:Microsoft.Xna.Framework.BoundingSphere instance on the right of the equal sign.
Returns: true if the instances are equal; false otherwise.
-
bool
op_Inequality
(BoundingSphere a, BoundingSphere b) Compares whether two T:Microsoft.Xna.Framework.BoundingSphere instances are not equal.
Parameters: - a (Microsoft.Xna.Framework.BoundingSphere) – T:Microsoft.Xna.Framework.BoundingSphere instance on the left of the not equal sign.
- b (Microsoft.Xna.Framework.BoundingSphere) – T:Microsoft.Xna.Framework.BoundingSphere instance on the right of the not equal sign.
Returns: true if the instances are not equal; false otherwise.
-
Vector3