Jolt Physics
A multi core friendly Game Physics Engine
Loading...
Searching...
No Matches
TaperedCylinderShapeSettings Class Referencefinal

Class that constructs a TaperedCylinderShape. More...

#include <TaperedCylinderShape.h>

Inheritance diagram for TaperedCylinderShapeSettings:
ConvexShapeSettings ShapeSettings SerializableObject RefTarget< ShapeSettings > NonCopyable

Public Member Functions

 TaperedCylinderShapeSettings ()=default
 Default constructor for deserialization.
 
 TaperedCylinderShapeSettings (float inHalfHeightOfTaperedCylinder, float inTopRadius, float inBottomRadius, float inConvexRadius=cDefaultConvexRadius, const PhysicsMaterial *inMaterial=nullptr)
 Create a tapered cylinder centered around the origin with bottom at (0, -inHalfHeightOfTaperedCylinder, 0) with radius inBottomRadius and top at (0, inHalfHeightOfTaperedCylinder, 0) with radius inTopRadius.
 
virtual ShapeResult Create () const override
 Create a shape according to the settings specified by this object.
 
- Public Member Functions inherited from ConvexShapeSettings
 ConvexShapeSettings ()=default
 Constructor.
 
 ConvexShapeSettings (const PhysicsMaterial *inMaterial)
 
void SetDensity (float inDensity)
 Set the density of the object in kg / m^3.
 
- Public Member Functions inherited from ShapeSettings
void ClearCachedResult ()
 
- Public Member Functions inherited from SerializableObject
virtual ~SerializableObject ()=default
 Constructor.
 
- Public Member Functions inherited from NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
void operator= (const NonCopyable &)=delete
 
- Public Member Functions inherited from RefTarget< ShapeSettings >
 RefTarget ()=default
 Constructor.
 
 RefTarget (const RefTarget &)
 
 ~RefTarget ()
 assert no one is referencing us
 
void SetEmbedded () const
 
RefTargetoperator= (const RefTarget &)
 Assignment operator.
 
uint32 GetRefCount () const
 Get current refcount of this object.
 
void AddRef () const
 Add or release a reference to this object.
 
void Release () const
 

Public Attributes

float mHalfHeight = 0.0f
 
float mTopRadius = 0.0f
 
float mBottomRadius = 0.0f
 
float mConvexRadius = 0.0f
 
- Public Attributes inherited from ConvexShapeSettings
RefConst< PhysicsMaterialmMaterial
 Material assigned to this shape.
 
float mDensity = 1000.0f
 Uniform density of the interior of the convex object (kg / m^3)
 
- Public Attributes inherited from ShapeSettings
uint64 mUserData = 0
 User data (to be used freely by the application)
 

Additional Inherited Members

- Public Types inherited from ShapeSettings
using ShapeResult = Result< Ref< Shape > >
 
- Static Public Member Functions inherited from RefTarget< ShapeSettings >
static int sInternalGetRefCountOffset ()
 INTERNAL HELPER FUNCTION USED BY SERIALIZATION.
 
- Protected Attributes inherited from ShapeSettings
ShapeResult mCachedResult
 
- Protected Attributes inherited from RefTarget< ShapeSettings >
atomic< uint32mRefCount
 Current reference count.
 
- Static Protected Attributes inherited from RefTarget< ShapeSettings >
static constexpr uint32 cEmbedded
 A large value that gets added to the refcount to mark the object as embedded.
 

Detailed Description

Class that constructs a TaperedCylinderShape.

Constructor & Destructor Documentation

◆ TaperedCylinderShapeSettings() [1/2]

TaperedCylinderShapeSettings::TaperedCylinderShapeSettings ( )
default

Default constructor for deserialization.

◆ TaperedCylinderShapeSettings() [2/2]

TaperedCylinderShapeSettings::TaperedCylinderShapeSettings ( float  inHalfHeightOfTaperedCylinder,
float  inTopRadius,
float  inBottomRadius,
float  inConvexRadius = cDefaultConvexRadius,
const PhysicsMaterial inMaterial = nullptr 
)

Create a tapered cylinder centered around the origin with bottom at (0, -inHalfHeightOfTaperedCylinder, 0) with radius inBottomRadius and top at (0, inHalfHeightOfTaperedCylinder, 0) with radius inTopRadius.

Member Function Documentation

◆ Create()

ShapeSettings::ShapeResult TaperedCylinderShapeSettings::Create ( ) const
overridevirtual

Create a shape according to the settings specified by this object.

Implements ShapeSettings.

Member Data Documentation

◆ mBottomRadius

float TaperedCylinderShapeSettings::mBottomRadius = 0.0f

◆ mConvexRadius

float TaperedCylinderShapeSettings::mConvexRadius = 0.0f

◆ mHalfHeight

float TaperedCylinderShapeSettings::mHalfHeight = 0.0f

◆ mTopRadius

float TaperedCylinderShapeSettings::mTopRadius = 0.0f

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