Class that constructs a PlaneShape. More...

#include <PlaneShape.h>

Inheritance diagram for PlaneShapeSettings:

Public Member Functions
	PlaneShapeSettings ()=default
	Default constructor for deserialization.

	PlaneShapeSettings (const Plane &inPlane, const PhysicsMaterial *inMaterial=nullptr, float inHalfExtent=cDefaultHalfExtent)
	Create a plane shape.

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

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

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
Plane	mPlane
	Plane that describes the shape. The negative half space is considered solid.

RefConst< PhysicsMaterial >	mMaterial
	Surface material of the plane.

float	mHalfExtent = cDefaultHalfExtent
	The bounding box of this plane will run from [-half_extent, half_extent]. Keep this as low as possible for better broad phase performance.

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

Static Public Attributes
static constexpr float	cDefaultHalfExtent = 1000.0f
	Default half-extent of the plane (total size along 1 axis will be 2 * half-extent)

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< 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 PlaneShape.

Constructor & Destructor Documentation

◆ PlaneShapeSettings() [1/2]

PlaneShapeSettings::PlaneShapeSettings ( )

default

Default constructor for deserialization.

◆ PlaneShapeSettings() [2/2]

PlaneShapeSettings::PlaneShapeSettings	(	const Plane &	inPlane,
		const PhysicsMaterial *	inMaterial = `nullptr`,
		float	inHalfExtent = `cDefaultHalfExtent`
	)

inline

Create a plane shape.

Member Function Documentation

◆ Create()

ShapeSettings::ShapeResult PlaneShapeSettings::Create ( ) const

overridevirtual

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

Implements ShapeSettings.

Member Data Documentation

◆ cDefaultHalfExtent

constexpr float PlaneShapeSettings::cDefaultHalfExtent = 1000.0f

staticconstexpr

Default half-extent of the plane (total size along 1 axis will be 2 * half-extent)

◆ mHalfExtent

float PlaneShapeSettings::mHalfExtent = cDefaultHalfExtent

The bounding box of this plane will run from [-half_extent, half_extent]. Keep this as low as possible for better broad phase performance.

◆ mMaterial

RefConst<PhysicsMaterial> PlaneShapeSettings::mMaterial

Surface material of the plane.

◆ mPlane

Plane PlaneShapeSettings::mPlane

Plane that describes the shape. The negative half space is considered solid.

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

Jolt/Physics/Collision/Shape/PlaneShape.h
Jolt/Physics/Collision/Shape/PlaneShape.cpp

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members