Class that constructs a StaticCompoundShape. Note that if you only want a compound of 1 shape, use a RotatedTranslatedShape instead. More...

Inheritance diagram for StaticCompoundShapeSettings:

Public Member Functions
virtual ShapeResult	Create () const override
	Create a shape according to the settings specified by this object.

ShapeResult	Create (TempAllocator &inTempAllocator) const
	Specialization of Create() function that allows specifying a temp allocator to avoid temporary memory allocations on the heap.

Public Member Functions inherited from CompoundShapeSettings
	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
void	ClearCachedResult ()

Public Member Functions inherited from SerializableObject
virtual	~SerializableObject ()=default
	Destructor.

Public Member Functions inherited from RefTarget< ShapeSettings >
	RefTarget ()=default
	Constructor.

	RefTarget (const RefTarget &)

	~RefTarget ()
	assert no one is referencing us

void	SetEmbedded () const

RefTarget &	operator= (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

Additional Inherited Members
Public Types inherited from CompoundShapeSettings
using	SubShapes = Array<SubShapeSettings>

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.

Public Attributes inherited from CompoundShapeSettings
SubShapes	mSubShapes

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

Protected Member Functions inherited from SerializableObject
	SerializableObject ()=default
	Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves.

	SerializableObject (const SerializableObject &)=default

SerializableObject &	operator= (const SerializableObject &)=default

Protected Attributes inherited from ShapeSettings
ShapeResult	mCachedResult

Protected Attributes inherited from RefTarget< ShapeSettings >
atomic< uint32 >	mRefCount
	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 StaticCompoundShape. Note that if you only want a compound of 1 shape, use a RotatedTranslatedShape instead.

Member Function Documentation

ShapeSettings::ShapeResult StaticCompoundShapeSettings::Create ( ) const

overridevirtual

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

ShapeSettings::ShapeResult StaticCompoundShapeSettings::Create ( TempAllocator & inTempAllocator ) const

Specialization of Create() function that allows specifying a temp allocator to avoid temporary memory allocations on the heap.

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