Struct heron_core::RotationConstraints

pub struct RotationConstraints {
    pub allow_x: bool,
    pub allow_y: bool,
    pub allow_z: bool,
}

Component that restrict what rotations can be caused by forces.

It must be inserted on the same entity of a RigidBody

Note that angular velocity may still be applied programmatically. This only restrict how rotation can change when force/torques are applied.

Example

fn spawn(mut commands: Commands) {
    commands.spawn_bundle(todo!("Spawn your sprite/mesh, incl. at least a GlobalTransform"))
        .insert(CollisionShape::Sphere { radius: 1.0 })
        .insert(RotationConstraints::lock()); // Prevent rotation caused by forces
}

Fields

allow_x: bool

Set to true to prevent rotations around the x axis

allow_y: bool

Set to true to prevent rotations around the y axis

allow_z: bool

Set to true to prevent rotations around the Z axis

Implementations

impl RotationConstraints

#[must_use]

pub fn lock() -> Self

Lock rotations around all axes

#[must_use]

pub fn allow() -> Self

Allow rotations around all axes

#[must_use]

pub fn restrict_to_x_only() -> Self

Allow rotation around the x axis only (and prevent rotating around the other axes)

#[must_use]

pub fn restrict_to_y_only() -> Self

Allow rotation around the y axis only (and prevent rotating around the other axes)

#[must_use]

pub fn restrict_to_z_only() -> Self

Allow rotation around the z axis only (and prevent rotating around the other axes)

Trait Implementations

impl Clone for RotationConstraints

fn clone(&self) -> RotationConstraints

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RotationConstraints

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RotationConstraints

fn default() -> Self

Returns the “default value” for a type.

impl GetTypeRegistration for RotationConstraints

fn get_type_registration() -> TypeRegistration

impl Reflect for RotationConstraints

fn type_name(&self) -> &str

fn any(&self) -> &dyn Any

fn any_mut(&mut self) -> &mut dyn Any

fn clone_value(&self) -> Box<dyn Reflect>

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

fn apply(&mut self, value: &dyn Reflect)

fn reflect_ref(&self) -> ReflectRef<'_>

fn reflect_mut(&mut self) -> ReflectMut<'_>

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable value, if serialization is supported. Otherwise None will be returned.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type) if hashing is supported. Otherwise None will be returned.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equal” comparison result if comparison is supported. Otherwise None will be returned.

impl Struct for RotationConstraints

fn field(&self, name: &str) -> Option<&dyn Reflect>

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

fn name_at(&self, index: usize) -> Option<&str>

fn field_len(&self) -> usize

fn iter_fields(&self) -> FieldIter<'_>

fn clone_dynamic(&self) -> DynamicStruct

impl Copy for RotationConstraints