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

#include <PhysicsMaterial.h>

Inheritance diagram for PhysicsMaterial:
SerializableObject RefTarget< PhysicsMaterial > NonCopyable PhysicsMaterialSimple

Public Types

using PhysicsMaterialResult = Result< Ref< PhysicsMaterial > >
 

Public Member Functions

virtual ~PhysicsMaterial () override=default
 Virtual destructor. More...
 
virtual const char * GetDebugName () const
 
virtual Color GetDebugColor () const
 
virtual void SaveBinaryState (StreamOut &inStream) const
 Saves the contents of the material in binary form to inStream. More...
 
- Public Member Functions inherited from SerializableObject
virtual ~SerializableObject ()=default
 Constructor. More...
 
- Public Member Functions inherited from NonCopyable
 NonCopyable ()=default
 
 NonCopyable (const NonCopyable &)=delete
 
void operator= (const NonCopyable &)=delete
 
- Public Member Functions inherited from RefTarget< PhysicsMaterial >
 RefTarget ()=default
 Constructor. More...
 
 RefTarget (const RefTarget &)
 
 ~RefTarget ()
 assert no one is referencing us More...
 
void SetEmbedded () const
 
RefTargetoperator= (const RefTarget &)
 Assignment operator. More...
 
uint32 GetRefCount () const
 Get current refcount of this object. More...
 
void AddRef () const
 Add or release a reference to this object. More...
 
void Release () const
 

Static Public Member Functions

static PhysicsMaterialResult sRestoreFromBinaryState (StreamIn &inStream)
 Creates a PhysicsMaterial of the correct type and restores its contents from the binary stream inStream. More...
 
- Static Public Member Functions inherited from RefTarget< PhysicsMaterial >
static int sInternalGetRefCountOffset ()
 INTERNAL HELPER FUNCTION USED BY SERIALIZATION. More...
 

Static Public Attributes

static RefConst< PhysicsMaterialsDefault
 Default material that is used when a shape has no materials defined. More...
 

Protected Member Functions

virtual void RestoreBinaryState (StreamIn &inStream)
 This function should not be called directly, it is used by sRestoreFromBinaryState. More...
 

Additional Inherited Members

- Protected Attributes inherited from RefTarget< PhysicsMaterial >
atomic< uint32mRefCount
 Current reference count. More...
 
- Static Protected Attributes inherited from RefTarget< PhysicsMaterial >
static constexpr uint32 cEmbedded
 A large value that gets added to the refcount to mark the object as embedded. More...
 

Detailed Description

This structure describes the surface of (part of) a shape. You should inherit from it to define additional information that is interesting for the simulation. The 2 materials involved in a contact could be used to decide which sound or particle effects to play.

If you inherit from this material, don't forget to create a suitable default material in sDefault

Member Typedef Documentation

◆ PhysicsMaterialResult

Constructor & Destructor Documentation

◆ ~PhysicsMaterial()

virtual PhysicsMaterial::~PhysicsMaterial ( )
overridevirtualdefault

Virtual destructor.

Member Function Documentation

◆ GetDebugColor()

virtual Color PhysicsMaterial::GetDebugColor ( ) const
inlinevirtual

Reimplemented in PhysicsMaterialSimple.

◆ GetDebugName()

virtual const char * PhysicsMaterial::GetDebugName ( ) const
inlinevirtual

Reimplemented in PhysicsMaterialSimple.

◆ RestoreBinaryState()

void PhysicsMaterial::RestoreBinaryState ( StreamIn inStream)
protectedvirtual

This function should not be called directly, it is used by sRestoreFromBinaryState.

Reimplemented in PhysicsMaterialSimple.

◆ SaveBinaryState()

void PhysicsMaterial::SaveBinaryState ( StreamOut inStream) const
virtual

Saves the contents of the material in binary form to inStream.

Reimplemented in PhysicsMaterialSimple.

◆ sRestoreFromBinaryState()

PhysicsMaterial::PhysicsMaterialResult PhysicsMaterial::sRestoreFromBinaryState ( StreamIn inStream)
static

Creates a PhysicsMaterial of the correct type and restores its contents from the binary stream inStream.

Member Data Documentation

◆ sDefault

JPH_NAMESPACE_BEGIN RefConst< PhysicsMaterial > PhysicsMaterial::sDefault
static

Default material that is used when a shape has no materials defined.


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