ReactPhysics3D  v0.10.1
C++ Physics engine library
reactphysics3d::BoxShape Class Reference

This class represents a 3D box shape. More...

#include <include/reactphysics3d/collision/shapes/BoxShape.h>

Inheritance diagram for reactphysics3d::BoxShape:
reactphysics3d::ConvexPolyhedronShape reactphysics3d::ConvexShape reactphysics3d::CollisionShape

Public Member Functions

 BoxShape (const BoxShape &shape)=delete
 Deleted copy-constructor.
 
BoxShapeoperator= (const BoxShape &shape)=delete
 Deleted assignment operator.
 
const Vector3getHalfExtents () const
 Return the half-extents of the box. More...
 
void setHalfExtents (const Vector3 &halfExtents)
 Set the half-extents of the box. More...
 
virtual AABB getLocalBounds () const override
 Return the local bounds of the shape in x, y and z directions. More...
 
virtual Vector3 getLocalInertiaTensor (decimal mass) const override
 Return the local inertia tensor of the collision shape. More...
 
virtual decimal getVolume () const override
 Compute and return the volume of the collision shape.
 
virtual uint32 getNbFaces () const override
 Return the number of faces of the polyhedron.
 
virtual const HalfEdgeStructure::FacegetFace (uint32 faceIndex) const override
 Return a given face of the polyhedron.
 
virtual uint32 getNbVertices () const override
 Return the number of vertices of the polyhedron.
 
virtual const HalfEdgeStructure::VertexgetVertex (uint32 vertexIndex) const override
 Return a given vertex of the polyhedron.
 
virtual uint32 getNbHalfEdges () const override
 Return the number of half-edges of the polyhedron.
 
virtual const HalfEdgeStructure::EdgegetHalfEdge (uint32 edgeIndex) const override
 Return a given half-edge of the polyhedron.
 
virtual Vector3 getVertexPosition (uint32 vertexIndex) const override
 Return the position of a given vertex.
 
virtual Vector3 getFaceNormal (uint32 faceIndex) const override
 Return the normal vector of a given face of the polyhedron.
 
virtual Vector3 getCentroid () const override
 Return the centroid of the polyhedron.
 
virtual std::string to_string () const override
 Return the string representation of the shape.
 
- Public Member Functions inherited from reactphysics3d::ConvexPolyhedronShape
 ConvexPolyhedronShape (CollisionShapeName name, MemoryAllocator &allocator)
 Constructor.
 
virtual ~ConvexPolyhedronShape () override=default
 Destructor.
 
 ConvexPolyhedronShape (const ConvexPolyhedronShape &shape)=delete
 Deleted copy-constructor.
 
ConvexPolyhedronShapeoperator= (const ConvexPolyhedronShape &shape)=delete
 Deleted assignment operator.
 
virtual bool isPolyhedron () const override
 Return true if the collision shape is a polyhedron.
 
uint32 findMostAntiParallelFace (const Vector3 &direction) const
 Find and return the index of the polyhedron face with the most anti-parallel face normal given a direction vector.
 
- Public Member Functions inherited from reactphysics3d::ConvexShape
 ConvexShape (CollisionShapeName name, CollisionShapeType type, MemoryAllocator &allocator, decimal margin=decimal(0.0))
 Constructor.
 
virtual ~ConvexShape () override=default
 Destructor.
 
 ConvexShape (const ConvexShape &shape)=delete
 Deleted copy-constructor.
 
ConvexShapeoperator= (const ConvexShape &shape)=delete
 Deleted assignment operator.
 
decimal getMargin () const
 Return the current object margin. More...
 
virtual bool isConvex () const override
 Return true if the collision shape is convex, false if it is concave.
 
- Public Member Functions inherited from reactphysics3d::CollisionShape
 CollisionShape (CollisionShapeName name, CollisionShapeType type, MemoryAllocator &allocator)
 Constructor.
 
virtual ~CollisionShape ()=default
 Destructor.
 
 CollisionShape (const CollisionShape &shape)=delete
 Deleted copy-constructor.
 
CollisionShapeoperator= (const CollisionShape &shape)=delete
 Deleted assignment operator.
 
CollisionShapeName getName () const
 Return the name of the collision shape. More...
 
CollisionShapeType getType () const
 Return the type of the collision shape. More...
 
uint32 getId () const
 Return the id of the shape.
 
virtual AABB computeTransformedAABB (const Transform &transform) const
 Compute the transformed AABB of the collision shape given a transform. More...
 

Detailed Description

This class represents a 3D box shape.

Those axis are unit length. The three extents are half-widths of the box along the three axis x, y, z local axis. The "transform" of the corresponding body will give an orientation and a position to the box.

Member Function Documentation

◆ getHalfExtents()

RP3D_FORCE_INLINE const Vector3 & reactphysics3d::BoxShape::getHalfExtents ( ) const

Return the half-extents of the box.

Returns
The vector with the three half-extents of the box shape

◆ getLocalBounds()

AABB BoxShape::getLocalBounds ( ) const
overridevirtual

Return the local bounds of the shape in x, y and z directions.

This method is used to compute the AABB of the box.

Returns
The AABB of the shape

Implements reactphysics3d::CollisionShape.

◆ getLocalInertiaTensor()

Vector3 BoxShape::getLocalInertiaTensor ( decimal  mass) const
overridevirtual

Return the local inertia tensor of the collision shape.

Parameters
massMass to use to compute the inertia tensor of the collision shape

Implements reactphysics3d::CollisionShape.

◆ setHalfExtents()

RP3D_FORCE_INLINE void reactphysics3d::BoxShape::setHalfExtents ( const Vector3 halfExtents)

Set the half-extents of the box.

Note that you might want to recompute the inertia tensor and center of mass of the body after changing the size of the collision shape.

Parameters
halfExtentsThe vector with the three half-extents of the box

The documentation for this class was generated from the following files: