Struct directx_math::collision::BoundingSphere

#[repr(C)]pub struct BoundingSphere {
    pub Center: XMFLOAT3,
    pub Radius: f32,
}

A bounding sphere object.

Fields

Center: XMFLOAT3

Radius: f32

Implementations

impl BoundingSphere

pub fn TransformMatrix(&self, Out: &mut Self, M: FXMMATRIX)

Transforms the BoundingSphere by the specified transformation matrix.

Parameters

Out The transformed BoundingSphere.

M The matrix to transform the BoundingSphere by.

Return value

None

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-transform

pub fn TransformDecomposed(
    &self,
    Out: &mut Self,
    Scale: f32,
    Rotation: FXMVECTOR,
    Translation: FXMVECTOR
)

Transforms the BoundingSphere using the specified scale, rotation and translation vectors.

Parameters

Out The transformed BoundingSphere.

Scale The value to scale the BoundingSphere by.

Rotation The value to rotate the BoundingSphere by.

Translation The value to translate the BoundingSphere by.

Return value

This method does not return a value.

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-transform(boundingsphere__float_fxmvector_fxmvector)

pub fn ContainsPoint(&self, Point: FXMVECTOR) -> ContainmentType

Tests whether the BoundingSphere contains a specified point.

Parameters

Point The point to test against.

Return value

A ContainmentType value indicating whether the BoundingSphere contains the specified point.

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-contains

pub fn ContainsTriangle(
    &self,
    V0: FXMVECTOR,
    V1: FXMVECTOR,
    V2: FXMVECTOR
) -> ContainmentType

Tests whether the BoundingSphere contains a specified triangle.

Parameters

V0 A corner of the triangle.

V1 A corner of the triangle.

V2 A corner of the triangle.

Return value

A ContainmentType value indicating whether the BoundingSphere contains the specified triangle.

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-contains(fxmvector_fxmvector_fxmvector)

pub fn ContainsSphere(&self, sh: &BoundingSphere) -> ContainmentType

Tests whether the BoundingSphere contains a specified BoundingSphere.

Parameters

sh The BoundingSphere to test against.

Return value

A ContainmentType value indicating whether the BoundingSphere contains the specified BoundingSphere.

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-contains(constboundingsphere_)

pub fn ContainsBox(&self, box_: &BoundingBox) -> ContainmentType

Tests whether the BoundingSphere contains a specified BoundingBox.

Parameters

box The BoundingBox to test against.

Return value

A ContainmentType value indicating whether the BoundingSphere contains the specified BoundingBox.

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-contains(constboundingbox_)

pub fn ContainsOrientedBox(&self, box_: &BoundingOrientedBox) -> ContainmentType

Tests whether the BoundingSphere contains the specified BoundingOrientedBox.

Parameters

box The BoundingOrientedBox to test against.

Return value

A ContainmentType value indicating whether the BoundingOrientedBox is contained in the BoundingSphere.

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-contains(constboundingorientedbox_)

pub fn ContainsFrustum(&self, fr: &BoundingFrustum) -> ContainmentType

Tests whether the BoundingSphere contains the specified BoundingFrustum.

Parameters

fr The BoundingFrustum to test against.

Return value

A ContainmentType value indicating whether the BoundingFrustum is contained in the BoundingSphere.

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-contains(constboundingfrustum_)

pub fn IntersectsSphere(&self, sh: &BoundingSphere) -> bool

Tests the BoundingSphere for intersection with a BoundingSphere.

Parameters

sh The BoundingSphere to test against.

Return value

A bool value indicating whether the BoundingSphere intersects the specified BoundingSphere.

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-intersects

pub fn IntersectsBox(&self, box_: &BoundingBox) -> bool

Tests the BoundingSphere for intersection with a BoundingBox.

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-intersects(constboundingbox_)

pub fn IntersectsOrientedBox(&self, box_: &BoundingOrientedBox) -> bool

Test the BoundingSphere for intersection with a BoundingOrientedBox.

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-intersects(constboundingorientedbox_)

pub fn IntersectsFrustum(&self, fr: &BoundingFrustum) -> bool

Test the BoundingSphere for intersection with a BoundingFrustum.

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-intersects(constboundingfrustum_)

pub fn IntersectsTriangle(
    &self,
    V0: FXMVECTOR,
    V1: FXMVECTOR,
    V2: FXMVECTOR
) -> bool

Tests the BoundingSphere for intersection with a triangle.

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-intersects(fxmvector_fxmvector_fxmvector)

pub fn IntersectsPlane(&self, Plane: FXMVECTOR) -> PlaneIntersectionType

Tests the BoundingSphere for intersection with a Plane.

Parameters

Plane A vector describing the plane coefficients (A, B, C, D) for the plane equation Ax+By+Cz+D=0.

Return value

A PlaneIntersectionType value indicating whether the BoundingSphere intersects the specified plane.

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-intersects(fxmvector)

pub fn IntersectsRay(
    &self,
    Origin: FXMVECTOR,
    Direction: FXMVECTOR,
    Dist: &mut f32
) -> bool

Tests the BoundingSphere for intersection with a ray.

Parameters

Origin The origin of the ray.

Direction The direction of the ray.

Dist The length of the ray.

Return value

A bool value indicating whether the BoundingSphere contains the specified ray.

Remarks

The distance from the Origin to the nearest intersection point is returned in Dist when the method returns true. Otherwise, Dist is set to 0.0.

Reference

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-intersects(fxmvector_fxmvector_float_)

pub fn ContainedBy(
    &self,
    Plane0: FXMVECTOR,
    Plane1: FXMVECTOR,
    Plane2: GXMVECTOR,
    Plane3: HXMVECTOR,
    Plane4: HXMVECTOR,
    Plane5: HXMVECTOR
) -> ContainmentType

Tests whether the BoundingSphere is contained by the specified frustum.

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-containedby

pub fn CreateMerged(Out: &mut Self, S1: &Self, S2: &Self)

Creates a BoundingSphere that contains the two specified BoundingSphere objects.

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-createmerged

pub fn CreateFromBoundingBox(Out: &mut Self, box_: &BoundingBox)

Creates a BoundingSphere containing the specified BoundingBox.

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-createfromboundingbox

pub fn CreateFromBoundingOrientedBox(Out: &mut Self, box_: &BoundingOrientedBox)

Creates a BoundingSphere containing the specified BoundingOrientedBox.

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-createfromboundingbox(boundingsphere__constboundingorientedbox_)

pub fn CreateFromPoints<'a>(
    Out: &mut Self,
    pPoints: impl Iterator<Item = &'a XMFLOAT3> + Clone
)

Creates a new BoundingSphere from a list of points.

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingsphere-createfrompoints

pub fn CreateFromFrustum(Out: &mut Self, fr: &BoundingFrustum)

Creates a BoundingSphere containing the specified BoundingFrustum.

Trait Implementations

impl Clone for BoundingSphere

fn clone(&self) -> BoundingSphere

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for BoundingSphere

impl Debug for BoundingSphere

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.