Struct directx_math::collision::BoundingBox

#[repr(C)]pub struct BoundingBox {
    pub Center: XMFLOAT3,
    pub Extents: XMFLOAT3,
}

A bounding axis-aligned object (AABB).

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/ns-directxcollision-boundingbox

Fields

Center: XMFLOAT3

Extents: XMFLOAT3

Implementations

impl BoundingBox

pub const CORNER_COUNT: usize

pub fn GetCorners(&self, Corners: &mut [XMFLOAT3; 8])

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

Transforms the BoundingBox by the specified transformation matrix..

Parameters

Out The transformed BoundingBox.

M The matrix to transform the BoundingBox by.

Return value

None

Reference

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

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

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

Parameters

Out The transformed BoundingBox.

Scale The value to scale the BoundingBox by.

Rotation The value to rotate the BoundingBox by.

Translation The value to translate the BoundingBox by.

Return value

This method does not return a value.

Reference

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

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

Tests the whether the BoundingBox contains a specified point.

Parameters

Point The point to test against.

Return value

A ContainmentType value indicating whether the point is contained in the BoundingBox.

Reference

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

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

Test whether the BoundingBox 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 BoundingBox contains the specified triangle.

Reference

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

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

Tests whether the BoundingBox contains a specified BoundingSphere.

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

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

Tests whether the BoundingBox contains a specified BoundingBox.

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

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

Tests whether the BoundingBox contains the specified BoundingOrientedBox.

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

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

Tests whether the BoundingBox contains the specified BoundingFrustum.

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

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

Tests the BoundingBox for intersection with a BoundingSphere.

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

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

Tests the BoundingBox for intersection with a BoundingBox.

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

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

Test the BoundingBox for intersection with a BoundingOrientedBox.

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

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

Test the BoundingBox for intersection with a BoundingFrustum.

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

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

Tests the BoundingSphere for intersection with a triangle.

Parameters

V0 A vector describing the triangle.

V1 A vector describing the triangle.

V2 A vector describing the triangle.

Return value

A bool value indicating whether the BoundingBox intersects the triangle.

Reference

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

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

Tests the BoundingBox 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-BoundingBox-intersects(fxmvector)

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

Tests the BoundingBox 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 BoundingBox intersects the 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-BoundingBox-intersects(fxmvector_fxmvector_float_)

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

Tests whether the BoundingBox is contained by the specified frustum.

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

pub fn CreateMerged(Out: &mut Self, b1: &Self, b2: &Self)

Creates a BoundingBox that contains the two specified BoundingBox objects.

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

pub fn CreateFromSphere(Out: &mut Self, sh: &BoundingSphere)

Creates a BoundingBox large enough to contain the a specified BoundingSphere.

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingbox-createfromsphere

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

Creates a new BoundingBox from a list of points.

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

Trait Implementations

impl Clone for BoundingBox

fn clone(&self) -> BoundingBox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BoundingBox

impl Debug for BoundingBox

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

Formats the value using the given formatter.