Jolt Physics
A multi core friendly Game Physics Engine
Loading...
Searching...
No Matches
CompoundShapeSettings Class Reference

Base class settings to construct a compound shape. More...

#include <CompoundShape.h>

Inheritance diagram for CompoundShapeSettings:
ShapeSettings SerializableObject RefTarget< ShapeSettings > NonCopyable MutableCompoundShapeSettings StaticCompoundShapeSettings

Classes

struct  SubShapeSettings
 

Public Types

using SubShapes = Array< SubShapeSettings >
 
- Public Types inherited from ShapeSettings
using ShapeResult = Result< Ref< Shape > >
 

Public Member Functions

 CompoundShapeSettings ()=default
 Constructor. Use AddShape to add the parts.
 
void AddShape (Vec3Arg inPosition, QuatArg inRotation, const ShapeSettings *inShape, uint32 inUserData=0)
 Add a shape to the compound.
 
void AddShape (Vec3Arg inPosition, QuatArg inRotation, const Shape *inShape, uint32 inUserData=0)
 Add a shape to the compound. Variant that uses a concrete shape, which means this object cannot be serialized.
 
- Public Member Functions inherited from ShapeSettings
virtual ShapeResult Create () const =0
 Create a shape according to the settings specified by this object.
 
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

SubShapes mSubShapes
 
- Public Attributes inherited from ShapeSettings
uint64 mUserData = 0
 User data (to be used freely by the application)
 

Additional Inherited Members

- 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

Base class settings to construct a compound shape.

Member Typedef Documentation

◆ SubShapes

Constructor & Destructor Documentation

◆ CompoundShapeSettings()

CompoundShapeSettings::CompoundShapeSettings ( )
default

Constructor. Use AddShape to add the parts.

Member Function Documentation

◆ AddShape() [1/2]

void CompoundShapeSettings::AddShape ( Vec3Arg  inPosition,
QuatArg  inRotation,
const Shape inShape,
uint32  inUserData = 0 
)

Add a shape to the compound. Variant that uses a concrete shape, which means this object cannot be serialized.

◆ AddShape() [2/2]

void CompoundShapeSettings::AddShape ( Vec3Arg  inPosition,
QuatArg  inRotation,
const ShapeSettings inShape,
uint32  inUserData = 0 
)

Add a shape to the compound.

Member Data Documentation

◆ mSubShapes

SubShapes CompoundShapeSettings::mSubShapes

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