hx3d::physics2d::Attractor Struct Reference

Physical gravity attractor. More...

#include <attractor.hpp>

Public Types

Public Member Functions
	Attractor (Type type)
	Create an attractor. More...
virtual bool	overlaps (const Ptr< Collider > &collider)=0
	Check if a collider overlaps the attractor. More...
virtual void	computeForce (const Ptr< Collider > &collider, const float dt)=0
	Compute the gravity force on a collider. More...

Static Public Member Functions
static void	setCurrentAttractor (const Ptr< Collider > &collider, const Ptr< Attractor > &attractor, const float dt)
	Defines the current attractor on a collider. More...
static void	applyForce (const Ptr< Collider > &collider, const Ptr< Attractor > &attractor, const float dt)
	Apply an attractor force on a collider. More...

Public Attributes
Type	type
	Attractor type.
unsigned int	priority
	Attractor priority.

Detailed Description

Physical gravity attractor.

Definition at line 34 of file attractor.hpp.

Member Enumeration Documentation

enum hx3d::physics2d::Attractor::Type

strong

Attractor type.

Enumerator
Global	Global attractor.
Zone	Zone attractor.
Point	Point attractor.

Definition at line 39 of file attractor.hpp.

Constructor & Destructor Documentation

hx3d::physics2d::Attractor::Attractor

(

Type

type

)

Create an attractor.

Parameters

type	Attractor type

Definition at line 6 of file attractor.cpp.

Member Function Documentation

void hx3d::physics2d::Attractor::applyForce ( const Ptr< Collider > &  collider, const Ptr< Attractor > &  attractor, const float  dt  )

static

Apply an attractor force on a collider.

Parameters

collider	Collider (Ptr)
attractor	Attractor (Ptr)
dt	Delta time

Definition at line 18 of file attractor.cpp.

virtual void hx3d::physics2d::Attractor::computeForce ( const Ptr< Collider > &  collider, const float  dt  )

pure virtual

Compute the gravity force on a collider.

Parameters

collider	Collider (Ptr)
dt	Delta time

Implemented in hx3d::physics2d::ZoneAttractor, hx3d::physics2d::GlobalAttractor, and hx3d::physics2d::PointAttractor.

virtual bool hx3d::physics2d::Attractor::overlaps ( const Ptr< Collider > &  collider )

pure virtual

Check if a collider overlaps the attractor.

Parameters

collider

Collider (Ptr)

Returns

True/False

Implemented in hx3d::physics2d::ZoneAttractor, hx3d::physics2d::GlobalAttractor, and hx3d::physics2d::PointAttractor.

void hx3d::physics2d::Attractor::setCurrentAttractor ( const Ptr< Collider > &  collider, const Ptr< Attractor > &  attractor, const float  dt  )

static

Defines the current attractor on a collider.

Parameters

collider	Collider (Ptr)
attractor	Attractor (Ptr)
dt	Delta time

Definition at line 13 of file attractor.cpp.

---

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

• engine/include/hx3d/physics/2d/attractor.hpp
• engine/src/physics/2d/attractor.cpp