Bullet Collision Detection & Physics Library
btCylinderShape Class Reference

The btCylinderShape class implements a cylinder shape primitive, centered around the origin. Its central axis aligned with the Y axis. btCylinderShapeX is aligned with the X axis and btCylinderShapeZ around the Z axis. More...

#include <btCylinderShape.h>

Inheritance diagram for btCylinderShape:
Collaboration diagram for btCylinderShape:

Public Member Functions

 BT_DECLARE_ALIGNED_ALLOCATOR ()
btVector3 getHalfExtentsWithMargin () const
const btVector3getHalfExtentsWithoutMargin () const
 btCylinderShape (const btVector3 &halfExtents)
void getAabb (const btTransform &t, btVector3 &aabbMin, btVector3 &aabbMax) const
 getAabb's default implementation is brute force, expected derived classes to implement a fast dedicated version
virtual void calculateLocalInertia (btScalar mass, btVector3 &inertia) const
virtual btVector3 localGetSupportingVertexWithoutMargin (const btVector3 &vec) const
virtual void batchedUnitVectorGetSupportingVertexWithoutMargin (const btVector3 *vectors, btVector3 *supportVerticesOut, int numVectors) const
virtual void setMargin (btScalar collisionMargin)
virtual btVector3 localGetSupportingVertex (const btVector3 &vec) const
int getUpAxis () const
virtual btVector3 getAnisotropicRollingFrictionDirection () const
 the getAnisotropicRollingFrictionDirection can be used in combination with setAnisotropicFriction See Bullet/Demos/RollingFrictionDemo for an example
virtual btScalar getRadius () const
virtual void setLocalScaling (const btVector3 &scaling)
virtual const char * getName () const
virtual int calculateSerializeBufferSize () const
virtual const char * serialize (void *dataBuffer, btSerializer *serializer) const
 fills the dataBuffer and returns the struct name (and 0 on failure)
Public Member Functions inherited from btConvexInternalShape
 BT_DECLARE_ALIGNED_ALLOCATOR ()
virtual ~btConvexInternalShape ()
const btVector3getImplicitShapeDimensions () const
void setImplicitShapeDimensions (const btVector3 &dimensions)
 warning: use setImplicitShapeDimensions with care changing a collision shape while the body is in the world is not recommended, it is best to remove the body from the world, then make the change, and re-add it alternatively flush the contact points, see documentation for 'cleanProxyFromPairs'
void setSafeMargin (btScalar minDimension, btScalar defaultMarginMultiplier=0.1f)
void setSafeMargin (const btVector3 &halfExtents, btScalar defaultMarginMultiplier=0.1f)
virtual void getAabbSlow (const btTransform &t, btVector3 &aabbMin, btVector3 &aabbMax) const
virtual const btVector3getLocalScaling () const
const btVector3getLocalScalingNV () const
virtual btScalar getMargin () const
btScalar getMarginNV () const
virtual int getNumPreferredPenetrationDirections () const
virtual void getPreferredPenetrationDirection (int index, btVector3 &penetrationVector) const
Public Member Functions inherited from btConvexShape
 BT_DECLARE_ALIGNED_ALLOCATOR ()
 btConvexShape ()
 not supported on IBM SDK, until we fix the alignment of btVector3
virtual ~btConvexShape ()
btVector3 localGetSupportVertexWithoutMarginNonVirtual (const btVector3 &vec) const
btVector3 localGetSupportVertexNonVirtual (const btVector3 &vec) const
btScalar getMarginNonVirtual () const
void getAabbNonVirtual (const btTransform &t, btVector3 &aabbMin, btVector3 &aabbMax) const
virtual void project (const btTransform &trans, const btVector3 &dir, btScalar &minProj, btScalar &maxProj, btVector3 &witnesPtMin, btVector3 &witnesPtMax) const
Public Member Functions inherited from btCollisionShape
 BT_DECLARE_ALIGNED_ALLOCATOR ()
 btCollisionShape ()
virtual ~btCollisionShape ()
virtual void getBoundingSphere (btVector3 &center, btScalar &radius) const
virtual btScalar getAngularMotionDisc () const
 getAngularMotionDisc returns the maximum radius needed for Conservative Advancement to handle time-of-impact with rotations.
virtual btScalar getContactBreakingThreshold (btScalar defaultContactThresholdFactor) const
void calculateTemporalAabb (const btTransform &curTrans, const btVector3 &linvel, const btVector3 &angvel, btScalar timeStep, btVector3 &temporalAabbMin, btVector3 &temporalAabbMax) const
 calculateTemporalAabb calculates the enclosing aabb for the moving object over interval [0..timeStep) result is conservative
bool isPolyhedral () const
bool isConvex2d () const
bool isConvex () const
bool isNonMoving () const
bool isConcave () const
bool isCompound () const
bool isSoftBody () const
bool isInfinite () const
 isInfinite is used to catch simulation error (aabb check)
int getShapeType () const
void setUserPointer (void *userPtr)
 optional user data pointer
void * getUserPointer () const
void setUserIndex (int index)
int getUserIndex () const
void setUserIndex2 (int index)
int getUserIndex2 () const
virtual void serializeSingleShape (btSerializer *serializer) const

Protected Attributes

int m_upAxis
Protected Attributes inherited from btConvexInternalShape
btVector3 m_localScaling
btVector3 m_implicitShapeDimensions
btScalar m_collisionMargin
btScalar m_padding
Protected Attributes inherited from btCollisionShape
int m_shapeType
void * m_userPointer
int m_userIndex
int m_userIndex2

Additional Inherited Members

Protected Member Functions inherited from btConvexInternalShape
 btConvexInternalShape ()

Detailed Description

The btCylinderShape class implements a cylinder shape primitive, centered around the origin. Its central axis aligned with the Y axis. btCylinderShapeX is aligned with the X axis and btCylinderShapeZ around the Z axis.

Definition at line 24 of file btCylinderShape.h.

Constructor & Destructor Documentation

◆ btCylinderShape()

btCylinderShape::btCylinderShape ( const btVector3 & halfExtents)

Definition at line 18 of file btCylinderShape.cpp.

Member Function Documentation

◆ batchedUnitVectorGetSupportingVertexWithoutMargin()

void btCylinderShape::batchedUnitVectorGetSupportingVertexWithoutMargin ( const btVector3 * vectors,
btVector3 * supportVerticesOut,
int numVectors ) const
virtual

Implements btConvexShape.

Reimplemented in btCylinderShapeX, and btCylinderShapeZ.

Definition at line 231 of file btCylinderShape.cpp.

◆ BT_DECLARE_ALIGNED_ALLOCATOR()

btCylinderShape::BT_DECLARE_ALIGNED_ALLOCATOR ( )

◆ calculateLocalInertia()

void btCylinderShape::calculateLocalInertia ( btScalar mass,
btVector3 & inertia ) const
virtual

Implements btCollisionShape.

Definition at line 47 of file btCylinderShape.cpp.

◆ calculateSerializeBufferSize()

int btCylinderShape::calculateSerializeBufferSize ( ) const
inlinevirtual

Reimplemented from btConvexInternalShape.

Definition at line 183 of file btCylinderShape.h.

◆ getAabb()

void btCylinderShape::getAabb ( const btTransform & t,
btVector3 & aabbMin,
btVector3 & aabbMax ) const
virtual

getAabb's default implementation is brute force, expected derived classes to implement a fast dedicated version

Reimplemented from btConvexInternalShape.

Definition at line 42 of file btCylinderShape.cpp.

◆ getAnisotropicRollingFrictionDirection()

virtual btVector3 btCylinderShape::getAnisotropicRollingFrictionDirection ( ) const
inlinevirtual

the getAnisotropicRollingFrictionDirection can be used in combination with setAnisotropicFriction See Bullet/Demos/RollingFrictionDemo for an example

Reimplemented from btCollisionShape.

Definition at line 94 of file btCylinderShape.h.

◆ getHalfExtentsWithMargin()

btVector3 btCylinderShape::getHalfExtentsWithMargin ( ) const
inline

Definition at line 34 of file btCylinderShape.h.

◆ getHalfExtentsWithoutMargin()

const btVector3 & btCylinderShape::getHalfExtentsWithoutMargin ( ) const
inline

Definition at line 42 of file btCylinderShape.h.

◆ getName()

virtual const char * btCylinderShape::getName ( ) const
inlinevirtual

Implements btCollisionShape.

Reimplemented in btCylinderShapeX, and btCylinderShapeZ.

Definition at line 118 of file btCylinderShape.h.

◆ getRadius()

virtual btScalar btCylinderShape::getRadius ( ) const
inlinevirtual

Reimplemented in btCylinderShapeX, and btCylinderShapeZ.

Definition at line 101 of file btCylinderShape.h.

◆ getUpAxis()

int btCylinderShape::getUpAxis ( ) const
inline

Definition at line 89 of file btCylinderShape.h.

◆ localGetSupportingVertex()

virtual btVector3 btCylinderShape::localGetSupportingVertex ( const btVector3 & vec) const
inlinevirtual

Reimplemented from btConvexInternalShape.

Definition at line 68 of file btCylinderShape.h.

◆ localGetSupportingVertexWithoutMargin()

btVector3 btCylinderShape::localGetSupportingVertexWithoutMargin ( const btVector3 & vec) const
virtual

Implements btConvexShape.

Reimplemented in btCylinderShapeX, and btCylinderShapeZ.

Definition at line 226 of file btCylinderShape.cpp.

◆ serialize()

const char * btCylinderShape::serialize ( void * dataBuffer,
btSerializer * serializer ) const
inlinevirtual

fills the dataBuffer and returns the struct name (and 0 on failure)

Reimplemented from btConvexInternalShape.

Definition at line 189 of file btCylinderShape.h.

◆ setLocalScaling()

virtual void btCylinderShape::setLocalScaling ( const btVector3 & scaling)
inlinevirtual

Reimplemented from btConvexInternalShape.

Definition at line 106 of file btCylinderShape.h.

◆ setMargin()

virtual void btCylinderShape::setMargin ( btScalar collisionMargin)
inlinevirtual

Reimplemented from btConvexInternalShape.

Definition at line 57 of file btCylinderShape.h.

Member Data Documentation

◆ m_upAxis

int btCylinderShape::m_upAxis
protected

Definition at line 29 of file btCylinderShape.h.


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