CharacterSettings Class Reference

Contains the configuration of a character. More...

#include <Character.h>

Inheritance diagram for CharacterSettings:

Public Member Functions
JPH_OVERRIDE_NEW_DELETE	CharacterSettings ()=default
	Constructor.
	CharacterSettings (const CharacterSettings &)=default
CharacterSettings &	operator= (const CharacterSettings &)=default
Public Member Functions inherited from CharacterBaseSettings
JPH_OVERRIDE_NEW_DELETE	CharacterBaseSettings ()=default
	Constructor.
	CharacterBaseSettings (const CharacterBaseSettings &)=default
CharacterBaseSettings &	operator= (const CharacterBaseSettings &)=default
virtual	~CharacterBaseSettings ()=default
	Virtual destructor.
Public Member Functions inherited from RefTarget< CharacterBaseSettings >
	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

Public Attributes
ObjectLayer	mLayer = 0
	Layer that this character will be added to.
float	mMass = 80.0f
	Mass of the character.
float	mFriction = 0.2f
	Friction for the character.
float	mGravityFactor = 1.0f
	Value to multiply gravity with for this character.
EAllowedDOFs	mAllowedDOFs = EAllowedDOFs::TranslationX | EAllowedDOFs::TranslationY | EAllowedDOFs::TranslationZ
	Allowed degrees of freedom for this character.
Public Attributes inherited from CharacterBaseSettings
Vec3	mUp = Vec3::sAxisY()
	Vector indicating the up direction of the character.
Plane	mSupportingVolume { Vec3::sAxisY(), -1.0e10f }
float	mMaxSlopeAngle = DegreesToRadians(50.0f)
	Maximum angle of slope that character can still walk on (radians).
bool	mEnhancedInternalEdgeRemoval = false
	Set to indicate that extra effort should be made to try to remove ghost contacts (collisions with internal edges of a mesh). This is more expensive but makes bodies move smoother over a mesh with convex edges.
RefConst< Shape >	mShape

Additional Inherited Members
Static Public Member Functions inherited from RefTarget< CharacterBaseSettings >
static int	sInternalGetRefCountOffset ()
	INTERNAL HELPER FUNCTION USED BY SERIALIZATION.
Protected Attributes inherited from RefTarget< CharacterBaseSettings >
atomic< uint32 >	mRefCount
	Current reference count.
Static Protected Attributes inherited from RefTarget< CharacterBaseSettings >
static constexpr uint32	cEmbedded
	A large value that gets added to the refcount to mark the object as embedded.

Detailed Description

Contains the configuration of a character.

Constructor & Destructor Documentation

CharacterSettings() [1/2]

JPH_OVERRIDE_NEW_DELETE CharacterSettings::CharacterSettings ( )

default

Constructor.

CharacterSettings() [2/2]

CharacterSettings::CharacterSettings ( const CharacterSettings & )

default

Member Function Documentation

operator=()

CharacterSettings & CharacterSettings::operator= ( const CharacterSettings & )

default

Member Data Documentation

mAllowedDOFs

EAllowedDOFs CharacterSettings::mAllowedDOFs = EAllowedDOFs::TranslationX | EAllowedDOFs::TranslationY | EAllowedDOFs::TranslationZ

Allowed degrees of freedom for this character.

mFriction

float CharacterSettings::mFriction = 0.2f

Friction for the character.

mGravityFactor

float CharacterSettings::mGravityFactor = 1.0f

Value to multiply gravity with for this character.

mLayer

ObjectLayer CharacterSettings::mLayer = 0

Layer that this character will be added to.

mMass

float CharacterSettings::mMass = 80.0f

Mass of the character.

---

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

• Jolt/Physics/Character/Character.h