Jolt Physics
A multi core friendly Game Physics Engine
Loading...
Searching...
No Matches
GroupFilter Class Referenceabstract

Abstract class that checks if two CollisionGroups collide. More...

#include <GroupFilter.h>

Inheritance diagram for GroupFilter:
SerializableObject RefTarget< GroupFilter > NonCopyable GroupFilterTable

Public Types

using GroupFilterResult = Result< Ref< GroupFilter > >
 

Public Member Functions

virtual ~GroupFilter () override=default
 Virtual destructor. More...
 
virtual bool CanCollide (const CollisionGroup &inGroup1, const CollisionGroup &inGroup2) const =0
 Check if two groups collide. More...
 
virtual void SaveBinaryState (StreamOut &inStream) const
 Saves the contents of the group filter 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< GroupFilter >
 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 GroupFilterResult sRestoreFromBinaryState (StreamIn &inStream)
 Creates a GroupFilter of the correct type and restores its contents from the binary stream inStream. More...
 
- Static Public Member Functions inherited from RefTarget< GroupFilter >
static int sInternalGetRefCountOffset ()
 INTERNAL HELPER FUNCTION USED BY SERIALIZATION. 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< GroupFilter >
atomic< uint32mRefCount
 Current reference count. More...
 
- Static Protected Attributes inherited from RefTarget< GroupFilter >
static constexpr uint32 cEmbedded
 A large value that gets added to the refcount to mark the object as embedded. More...
 

Detailed Description

Abstract class that checks if two CollisionGroups collide.

Member Typedef Documentation

◆ GroupFilterResult

Constructor & Destructor Documentation

◆ ~GroupFilter()

virtual GroupFilter::~GroupFilter ( )
overridevirtualdefault

Virtual destructor.

Member Function Documentation

◆ CanCollide()

virtual bool GroupFilter::CanCollide ( const CollisionGroup inGroup1,
const CollisionGroup inGroup2 
) const
pure virtual

Check if two groups collide.

Implemented in GroupFilterTable.

◆ RestoreBinaryState()

void GroupFilter::RestoreBinaryState ( StreamIn inStream)
protectedvirtual

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

Reimplemented in GroupFilterTable.

◆ SaveBinaryState()

void GroupFilter::SaveBinaryState ( StreamOut inStream) const
virtual

Saves the contents of the group filter in binary form to inStream.

Reimplemented in GroupFilterTable.

◆ sRestoreFromBinaryState()

GroupFilter::GroupFilterResult GroupFilter::sRestoreFromBinaryState ( StreamIn inStream)
static

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


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