Struct directx_math::collision::BoundingOrientedBox

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

An oriented bounding box object (OBB).

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

Fields

Center: XMFLOAT3

Extents: XMFLOAT3

Orientation: XMFLOAT4

Implementations

impl BoundingOrientedBox

pub const CORNER_COUNT: usize

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

Transforms the BoundingOrientedBox by the specified transformation matrix.

Parameters

Out The transformed BoundingOrientedBox.

M The matrix to transform the BoundingOrientedBox with.

Return value

This method does not return a value.

Reference

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

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

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

Parameters

Out The transformed BoundingOrientedBox.

Scale The value to scale the BoundingOrientedBox by.

Rotation The value to rotate the BoundingOrientedBox by.

Translation The value to translate the BoundingOrientedBox by.

Return value

This method does not return a value.

Reference

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

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

Tests whether the BoundingOrientedBox contains a specified point.

Parameters

Point The point to test against.

Return value

A ContainmentType indicating whether point is contained in the BoundingOrientedBox.

Reference

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

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

Tests whether the BoundingOrientedBox contains a triangle.

Parameters

V0 A vector describing the triangle.

V1 A vector describing the triangle.

V2 A vector describing the triangle.

Return value

A ContainmentType indicating whether triangle is contained in the BoundingOrientedBox.

Reference

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

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

Tests whether the BoundingOrientedBox contains a specified BoundingSphere.

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

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

Tests whether the BoundingOrientedBox contains a specified BoundingBox.

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

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

Tests whether the BoundingOrientedBox contains the specified BoundingOrientedBox.

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

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

Tests whether the BoundingOrientedBox contains the specified BoundingFrustum.

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

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

Tests the BoundingOrientedBox for intersection with a BoundingSphere.

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

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

Tests the BoundingOrientedBox for intersection with a BoundingBox.

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

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

Test the BoundingOrientedBox for intersection with a BoundingOrientedBox.

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

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

Test the BoundingOrientedBox for intersection with a BoundingFrustum.

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

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

Tests the BoundingOrientedBox 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 boolean value indicating whether the BoundingOrientedBox intersects the triangle.

Reference

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

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

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

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

Tests the BoundingOrientedBox 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 boolean value indicating whether the BoundingOrientedBox 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-BoundingOrientedBox-intersects(fxmvector_fxmvector_float_)

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

Tests whether the BoundingOrientedBox is contained by the specified frustum.

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

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

Create oriented bounding box from axis-aligned bounding box

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-BoundingOrientedBox-CreateFromBoundingBox

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

Creates a new BoundingOrientedBox from a list of points.

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

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

Retrieves the corners of the BoundingOrientedBox.

https://docs.microsoft.com/en-us/windows/win32/api/directxcollision/nf-directxcollision-boundingorientedbox-getcorners

Trait Implementations

impl Clone for BoundingOrientedBox

fn clone(&self) -> BoundingOrientedBox

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BoundingOrientedBox

impl Debug for BoundingOrientedBox

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

Formats the value using the given formatter.