GroupFilter Class Reference

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

#include <GroupFilter.h>

Inheritance diagram for GroupFilter:

Public Types
using	GroupFilterResult = Result<Ref<GroupFilter>>

Public Member Functions
virtual	~GroupFilter () override=default
	Virtual destructor.
virtual bool	CanCollide (const CollisionGroup &inGroup1, const CollisionGroup &inGroup2) const =0
	Check if two groups collide.
virtual void	SaveBinaryState (StreamOut &inStream) const
	Saves the contents of the group filter in binary form to inStream.
Public Member Functions inherited from SerializableObject
virtual	~SerializableObject ()=default
	Destructor.
Public Member Functions inherited from RefTarget< GroupFilter >
	RefTarget ()=default
	Constructor.
	~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

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.
Static Public Member Functions inherited from RefTarget< GroupFilter >
static int	sInternalGetRefCountOffset ()
	INTERNAL HELPER FUNCTION USED BY SERIALIZATION.

Protected Member Functions
	GroupFilter ()=default
	Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves.
	GroupFilter (const GroupFilter &)=default
GroupFilter &	operator= (const GroupFilter &)=default
virtual void	RestoreBinaryState (StreamIn &inStream)
	This function should not be called directly, it is used by sRestoreFromBinaryState.
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

Additional Inherited Members
Protected Attributes inherited from RefTarget< GroupFilter >
atomic< uint32 >	mRefCount
	Current reference count.
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.

Detailed Description

Abstract class that checks if two CollisionGroups collide.

Member Typedef Documentation

GroupFilterResult

using GroupFilter::GroupFilterResult = Result<Ref<GroupFilter>>

Constructor & Destructor Documentation

~GroupFilter()

virtual GroupFilter::~GroupFilter ( )

overridevirtualdefault

Virtual destructor.

GroupFilter() [1/2]

GroupFilter::GroupFilter ( )

protecteddefault

Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves.

GroupFilter() [2/2]

GroupFilter::GroupFilter ( const GroupFilter & )

protecteddefault

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.

operator=()

GroupFilter & GroupFilter::operator= ( const GroupFilter & )

protecteddefault

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:

• Jolt/Physics/Collision/GroupFilter.h
• Jolt/Physics/Collision/GroupFilter.cpp