nc::Constraint Class Reference

A physics constraint attaching the owning RigidBody to another. More...

#include <Constraints.h>

Public Member Functions
	Constraint (const ConstraintInfo &info, Entity otherBody, ConstraintId id)
auto	GetInfo () -> ConstraintInfo &
	Get the ConstraintInfo. More...
auto	GetInfo () const -> const ConstraintInfo &
auto	GetType () const -> ConstraintType
	Get the type of constraint.
void	NotifyUpdateInfo ()
	Update internal state based on the current ConstraintInfo values.
void	SetConstraintTarget (RigidBody *otherBody=nullptr)
	Update the body that the Constraint owner is attached to (use nullptr to attach to the world).
auto	GetConstraintTarget () const -> Entity
void	Enable (bool enabled)
	Toggle the Constraint on or off.
auto	IsEnabled () const -> bool
auto	GetId () const -> ConstraintId
	Get the Constraint's unique identifier.

Friends
class	physics::ConstraintManager

Detailed Description

A physics constraint attaching the owning RigidBody to another.

Member Function Documentation

GetInfo()

auto nc::Constraint::GetInfo ( ) -> ConstraintInfo&

inline

Get the ConstraintInfo.

Note

Settings may be modified but changes won't take effect until NotifyUpdateInfo() is called.

---

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

• include/ncengine/physics/Constraints.h