A named rigid body with state, material properties, geometry, and forces. More...

#include <Entity.h>

Collaboration diagram for FxEntity:

Public Member Functions
bool	is_sleeping () const

void	wake ()

void	sleep ()

void	tick_sleep (float dt)

	FxEntity (const std::string &entityName)

const std::string &	get_name () const

uint32_t	get_entity_id () const

void	set_entity_id (uint32_t id)

int32_t	broad_phase_node () const

void	set_broad_phase_node (int32_t node)

int32_t	packed_index () const

void	set_packed_index (int32_t index)

void	reset ()

void	set_mass (const float &mass)

void	set_inertia ()

void	set_inertia (const float &inertia)

float	mass () const

float	inertia () const

float	inv_mass () const

float	inv_inertia () const

void	set_init_pose (const FxVec3f &o_pose)

void	set_init_velocity (const FxVec3f &o_velocity)

void	enable_external_forces (bool enable)

void	set_visual_geometry (FxVisualShape visual)

void	set_collision_geometry (FxCollisionShape collision)

const std::shared_ptr< FxVisualShape > &	visual_geometry () const

const std::shared_ptr< FxCollisionShape > &	collision_geometry () const

void	del_visual_geometry ()

void	del_collision_geometry ()

const FxArray< float > &	bounding_box () const

bool	aabb_overlap_check (const FxEntity &other) const

bool	aabb_overlap_check (const std::shared_ptr< FxEntity > &other) const

void	apply_torque (float torque)

void	apply_force (const FxVec2f &force)

void	apply_force (const FxVec2f &force, const FxVec2f &contact_point)

void	apply_impulse (const FxVec2f &impulse)

void	apply_impulse (const FxVec2f &impulse, const FxVec2f &contact_point)

FxVec2f	velocity_at_world_point (const FxVec2f &position) const

FxVec2f	velocity_at_local_point (const FxVec2f &local_position) const

FxVec2fArray	velocity_at_world_point (const FxVec2fArray &position) const

FxVec2fArray	velocity_at_local_point (const FxVec2fArray &local_position) const

FxVec2f	to_world_frame (const FxVec2f &local_point) const

FxVec2f	to_entity_frame (const FxVec2f &world_point) const

FxVec3f	calc_acceleration ()

FxVec3f	calc_acceleration (const FxVec2f &gravity)

FxVec3f	apply_pose_correction (const FxVec3f &delta)

void	step (const FxVec2f &gravity, const double &step_dt)

	~FxEntity ()

Public Attributes
FxVec3f	pose {0, 0, 0}

FxVec3f	velocity {0, 0, 0}

FxVec3f	prev_pose {0, 0, 0}

FxVec3f	prev_velocity {0, 0, 0}

float	elasticity = 0.1f

float	vel_damping = 0.0f

float	gravity_scale = 1.0f

float	static_friction = 0.0f

float	dynamic_friction = 0.0f

bool	enabled = true

bool	enable_ccd = false

bool	is_sensor = false

int32_t	collision_group = 0

float	sleep_threshold_linear = 0.01f

float	sleep_threshold_angular = 0.05f

float	sleep_time_required = 0.5f

Detailed Description

A named rigid body with state, material properties, geometry, and forces.

Definition at line 49 of file Entity.h.

Constructor & Destructor Documentation

◆ FxEntity()

FxEntity::FxEntity ( const std::string & entityName )

explicit

◆ ~FxEntity()

FxEntity::~FxEntity ( )

inline

Definition at line 225 of file Entity.h.

Member Function Documentation

◆ aabb_overlap_check() [1/2]

bool FxEntity::aabb_overlap_check ( const FxEntity & other ) const

◆ aabb_overlap_check() [2/2]

bool FxEntity::aabb_overlap_check ( const std::shared_ptr< FxEntity > & other ) const

◆ apply_force() [1/2]

void FxEntity::apply_force ( const FxVec2f & force )

◆ apply_force() [2/2]

void FxEntity::apply_force	(	const FxVec2f &	force,
		const FxVec2f &	contact_point
	)

◆ apply_impulse() [1/2]

void FxEntity::apply_impulse ( const FxVec2f & impulse )

◆ apply_impulse() [2/2]

void FxEntity::apply_impulse	(	const FxVec2f &	impulse,
		const FxVec2f &	contact_point
	)

◆ apply_pose_correction()

FxVec3f FxEntity::apply_pose_correction ( const FxVec3f & delta )

◆ apply_torque()

void FxEntity::apply_torque ( float torque )

◆ bounding_box()

const FxArray< float > & FxEntity::bounding_box ( ) const

◆ broad_phase_node()

int32_t FxEntity::broad_phase_node ( ) const

inline

Definition at line 146 of file Entity.h.

◆ calc_acceleration() [1/2]

FxVec3f FxEntity::calc_acceleration ( )

◆ calc_acceleration() [2/2]

FxVec3f FxEntity::calc_acceleration ( const FxVec2f & gravity )

◆ collision_geometry()

const std::shared_ptr< FxCollisionShape > & FxEntity::collision_geometry ( ) const

inline

Definition at line 186 of file Entity.h.

◆ del_collision_geometry()

void FxEntity::del_collision_geometry ( )

inline

Definition at line 189 of file Entity.h.

◆ del_visual_geometry()

void FxEntity::del_visual_geometry ( )

inline

Definition at line 188 of file Entity.h.

◆ enable_external_forces()

void FxEntity::enable_external_forces ( bool enable )

◆ get_entity_id()

uint32_t FxEntity::get_entity_id ( ) const

inline

Definition at line 141 of file Entity.h.

◆ get_name()

const std::string & FxEntity::get_name ( ) const

inline

Definition at line 140 of file Entity.h.

◆ inertia()

float FxEntity::inertia ( ) const

inline

Definition at line 160 of file Entity.h.

◆ inv_inertia()

float FxEntity::inv_inertia ( ) const

inline

Definition at line 162 of file Entity.h.

◆ inv_mass()

float FxEntity::inv_mass ( ) const

inline

Definition at line 161 of file Entity.h.

◆ is_sleeping()

bool FxEntity::is_sleeping ( ) const

inline

Definition at line 128 of file Entity.h.

◆ mass()

float FxEntity::mass ( ) const

inline

Definition at line 159 of file Entity.h.

◆ packed_index()

int32_t FxEntity::packed_index ( ) const

inline

Definition at line 148 of file Entity.h.

◆ reset()

void FxEntity::reset ( )

◆ set_broad_phase_node()

void FxEntity::set_broad_phase_node ( int32_t node )

inline

Definition at line 147 of file Entity.h.

◆ set_collision_geometry()

void FxEntity::set_collision_geometry ( FxCollisionShape collision )

inline

Definition at line 175 of file Entity.h.

◆ set_entity_id()

void FxEntity::set_entity_id ( uint32_t id )

inline

Definition at line 142 of file Entity.h.

◆ set_inertia() [1/2]

void FxEntity::set_inertia ( )

◆ set_inertia() [2/2]

void FxEntity::set_inertia ( const float & inertia )

◆ set_init_pose()

void FxEntity::set_init_pose ( const FxVec3f & o_pose )

◆ set_init_velocity()

void FxEntity::set_init_velocity ( const FxVec3f & o_velocity )

◆ set_mass()

void FxEntity::set_mass ( const float & mass )

◆ set_packed_index()

void FxEntity::set_packed_index ( int32_t index )

inline

Definition at line 149 of file Entity.h.

◆ set_visual_geometry()

void FxEntity::set_visual_geometry ( FxVisualShape visual )

inline

Definition at line 171 of file Entity.h.

◆ sleep()

void FxEntity::sleep ( )

inline

Definition at line 133 of file Entity.h.

◆ step()

void FxEntity::step	(	const FxVec2f &	gravity,
		const double &	step_dt
	)

◆ tick_sleep()

void FxEntity::tick_sleep ( float dt )

◆ to_entity_frame()

FxVec2f FxEntity::to_entity_frame ( const FxVec2f & world_point ) const

◆ to_world_frame()

FxVec2f FxEntity::to_world_frame ( const FxVec2f & local_point ) const

◆ velocity_at_local_point() [1/2]

FxVec2f FxEntity::velocity_at_local_point ( const FxVec2f & local_position ) const

◆ velocity_at_local_point() [2/2]

FxVec2fArray FxEntity::velocity_at_local_point ( const FxVec2fArray & local_position ) const

◆ velocity_at_world_point() [1/2]

FxVec2f FxEntity::velocity_at_world_point ( const FxVec2f & position ) const

◆ velocity_at_world_point() [2/2]

FxVec2fArray FxEntity::velocity_at_world_point ( const FxVec2fArray & position ) const

◆ visual_geometry()

const std::shared_ptr< FxVisualShape > & FxEntity::visual_geometry ( ) const

inline

Definition at line 185 of file Entity.h.

◆ wake()

void FxEntity::wake ( )

inline

Definition at line 129 of file Entity.h.

Member Data Documentation

◆ collision_group

int32_t FxEntity::collision_group = 0

Definition at line 121 of file Entity.h.

◆ dynamic_friction

float FxEntity::dynamic_friction = 0.0f

Definition at line 113 of file Entity.h.

◆ elasticity

float FxEntity::elasticity = 0.1f

Definition at line 108 of file Entity.h.

◆ enable_ccd

bool FxEntity::enable_ccd = false

Definition at line 118 of file Entity.h.

◆ enabled

bool FxEntity::enabled = true

Definition at line 116 of file Entity.h.

◆ gravity_scale

float FxEntity::gravity_scale = 1.0f

Definition at line 111 of file Entity.h.

◆ is_sensor

bool FxEntity::is_sensor = false

Definition at line 120 of file Entity.h.

◆ pose

FxVec3f FxEntity::pose {0, 0, 0}

Definition at line 100 of file Entity.h.

◆ prev_pose

FxVec3f FxEntity::prev_pose {0, 0, 0}

Definition at line 104 of file Entity.h.

◆ prev_velocity

FxVec3f FxEntity::prev_velocity {0, 0, 0}

Definition at line 105 of file Entity.h.

◆ sleep_threshold_angular

float FxEntity::sleep_threshold_angular = 0.05f

Definition at line 126 of file Entity.h.

◆ sleep_threshold_linear

float FxEntity::sleep_threshold_linear = 0.01f

Definition at line 125 of file Entity.h.

◆ sleep_time_required

float FxEntity::sleep_time_required = 0.5f

Definition at line 127 of file Entity.h.

◆ static_friction

float FxEntity::static_friction = 0.0f

Definition at line 112 of file Entity.h.

◆ vel_damping

float FxEntity::vel_damping = 0.0f

Definition at line 110 of file Entity.h.

◆ velocity

FxVec3f FxEntity::velocity {0, 0, 0}

Definition at line 101 of file Entity.h.

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

include/Fx2D/Entity.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FxEntity()

◆ ~FxEntity()

Member Function Documentation

◆ aabb_overlap_check() [1/2]

◆ aabb_overlap_check() [2/2]

◆ apply_force() [1/2]

◆ apply_force() [2/2]

◆ apply_impulse() [1/2]

◆ apply_impulse() [2/2]

◆ apply_pose_correction()

◆ apply_torque()

◆ bounding_box()

◆ broad_phase_node()

◆ calc_acceleration() [1/2]

◆ calc_acceleration() [2/2]

◆ collision_geometry()

◆ del_collision_geometry()

◆ del_visual_geometry()

◆ enable_external_forces()

◆ get_entity_id()

◆ get_name()

◆ inertia()

◆ inv_inertia()

◆ inv_mass()

◆ is_sleeping()

◆ mass()

◆ packed_index()

◆ reset()

◆ set_broad_phase_node()

◆ set_collision_geometry()

◆ set_entity_id()

◆ set_inertia() [1/2]

◆ set_inertia() [2/2]

◆ set_init_pose()

◆ set_init_velocity()

◆ set_mass()

◆ set_packed_index()

◆ set_visual_geometry()

◆ sleep()

◆ step()

◆ tick_sleep()

◆ to_entity_frame()

◆ to_world_frame()

◆ velocity_at_local_point() [1/2]

◆ velocity_at_local_point() [2/2]

◆ velocity_at_world_point() [1/2]

◆ velocity_at_world_point() [2/2]

◆ visual_geometry()

◆ wake()

Member Data Documentation

◆ collision_group

◆ dynamic_friction

◆ elasticity

◆ enable_ccd

◆ enabled

◆ gravity_scale

◆ is_sensor

◆ pose

◆ prev_pose

◆ prev_velocity

◆ sleep_threshold_angular

◆ sleep_threshold_linear

◆ sleep_time_required

◆ static_friction

◆ vel_damping

◆ velocity