Struct Transform

pub struct Transform { /* private fields */ }

See module docs.

Implementations

impl Transform

pub const LOCAL_SCALE: &'static str = "local_scale"

pub const LOCAL_POSITION: &'static str = "local_position"

pub const LOCAL_ROTATION: &'static str = "local_rotation"

pub const PRE_ROTATION: &'static str = "pre_rotation"

pub const POST_ROTATION: &'static str = "post_rotation"

pub const ROTATION_OFFSET: &'static str = "rotation_offset"

pub const ROTATION_PIVOT: &'static str = "rotation_pivot"

pub const SCALING_OFFSET: &'static str = "scaling_offset"

pub const SCALING_PIVOT: &'static str = "scaling_pivot"

impl Transform

pub fn identity() -> Self

Creates new transform that has no effect, in other words any vector or matrix will remain unchanged if combined with identity transform.

pub fn position(&self) -> &InheritableVariable<Vector3<f32>>

Returns current position of transform.

pub fn set_position(&mut self, local_position: Vector3<f32>) -> &mut Self

Sets position of transform.

pub fn rotation(&self) -> &InheritableVariable<UnitQuaternion<f32>>

Returns current rotation quaternion of transform.

pub fn set_rotation(&mut self, local_rotation: UnitQuaternion<f32>) -> &mut Self

Sets rotation of transform.

pub fn scale(&self) -> &InheritableVariable<Vector3<f32>>

Returns current scale factor of transform.

pub fn set_scale(&mut self, local_scale: Vector3<f32>) -> &mut Self

Sets scale of transform.

pub fn set_pre_rotation( &mut self, pre_rotation: UnitQuaternion<f32>, ) -> &mut Self

Sets pre-rotation of transform. Usually pre-rotation can be used to change “coordinate” system of transform. It is mostly for FBX compatibility, and never used in other places of engine.

pub fn pre_rotation(&self) -> &InheritableVariable<UnitQuaternion<f32>>

Returns current pre-rotation of transform.

pub fn set_post_rotation( &mut self, post_rotation: UnitQuaternion<f32>, ) -> &mut Self

Sets post-rotation of transform. Usually post-rotation can be used to change “coordinate” system of transform. It is mostly for FBX compatibility, and never used in other places of engine.

pub fn post_rotation(&self) -> &InheritableVariable<UnitQuaternion<f32>>

Returns current post-rotation of transform.

pub fn set_rotation_offset( &mut self, rotation_offset: Vector3<f32>, ) -> &mut Self

Sets rotation offset of transform. Moves rotation pivot using given vector, it results in rotation being performed around rotation pivot with some offset.

pub fn rotation_offset(&self) -> &InheritableVariable<Vector3<f32>>

Returns current rotation offset of transform.

pub fn set_rotation_pivot(&mut self, rotation_pivot: Vector3<f32>) -> &mut Self

Sets rotation pivot of transform. This method sets a point around which all rotations will be performed. For example it can be used to rotate a cube around its vertex.

pub fn rotation_pivot(&self) -> &InheritableVariable<Vector3<f32>>

Returns current rotation pivot of transform.

pub fn set_scaling_offset(&mut self, scaling_offset: Vector3<f32>) -> &mut Self

Sets scaling offset. Scaling offset defines offset from position of scaling pivot.

pub fn scaling_offset(&self) -> &InheritableVariable<Vector3<f32>>

Returns current scaling offset of transform.

pub fn set_scaling_pivot(&mut self, scaling_pivot: Vector3<f32>) -> &mut Self

Sets scaling pivot. Scaling pivot sets a point around which scale will be performed.

pub fn scaling_pivot(&self) -> &InheritableVariable<Vector3<f32>>

Returns current scaling pivot of transform.

pub fn offset(&mut self, vec: Vector3<f32>) -> &mut Self

Shifts local position using given vector. It is a shortcut for: set_position(position() + offset)

pub fn matrix(&self) -> Matrix4<f32>

Returns matrix which is final result of transform. Matrix then can be used to transform a vector, or combine with other matrix, to make transform hierarchy for example.

Trait Implementations

impl Clone for Transform

fn clone(&self) -> Transform

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Transform

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

Formats the value using the given formatter.

impl Default for Transform

fn default() -> Self

Returns the “default value” for a type.

impl Reflect for Transform

where Self: 'static, InheritableVariable<Vector3<f32>>: Reflect, InheritableVariable<UnitQuaternion<f32>>: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

fn into_any(self: Box<Self>) -> Box<dyn Any>

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

fn set_field( &mut self, name: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_any(&self, func: &mut dyn FnMut(&dyn Any))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut dyn Any))

fn as_reflect(&self, func: &mut dyn FnMut(&dyn Reflect))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut dyn Reflect))

fn fields(&self, func: &mut dyn FnMut(&[&dyn Reflect]))

fn fields_mut(&mut self, func: &mut dyn FnMut(&mut [&mut dyn Reflect]))

fn field(&self, name: &str, func: &mut dyn FnMut(Option<&dyn Reflect>))

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

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl Visit for Transform

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

Read or write this value, depending on whether Visitor::is_reading() is true or false.