Struct fyrox_scripts::camera::FlyingCameraController

pub struct FlyingCameraController {

    pub yaw: InheritableVariable<f32>,
    pub pitch: InheritableVariable<f32>,
    pub speed: InheritableVariable<f32>,
    pub sensitivity: InheritableVariable<f32>,
    pub pitch_limit: InheritableVariable<Range<f32>>,
    pub move_forward_key: InheritableVariable<KeyBinding>,
    pub move_backward_key: InheritableVariable<KeyBinding>,
    pub move_left_key: InheritableVariable<KeyBinding>,
    pub move_right_key: InheritableVariable<KeyBinding>,
    pub acceleration_curve: InheritableVariable<Curve>,
    pub deceleration_curve: InheritableVariable<Curve>,
    pub acceleration_time: InheritableVariable<f32>,
    pub deceleration_time: InheritableVariable<f32>,
    pub reactivity: InheritableVariable<f32>,
    pub velocity: InheritableVariable<Vector3<f32>>,
    pub target_velocity: InheritableVariable<Vector3<f32>>,
    pub acceleration_coeff: f32,
    pub move_forward: bool,
    pub move_backward: bool,
    pub move_left: bool,
    pub move_right: bool,
}

Flying camera controller script is used to create flying cameras, that can be rotated via mouse and moved via keyboard keys. Use it, if you need to create a sort of “spectator” camera. To use it, all you need to do is to assign it to your camera node (or one if its parent nodes).

Fields

yaw: InheritableVariable<f32>

pitch: InheritableVariable<f32>

speed: InheritableVariable<f32>

sensitivity: InheritableVariable<f32>

pitch_limit: InheritableVariable<Range<f32>>

move_forward_key: InheritableVariable<KeyBinding>

move_backward_key: InheritableVariable<KeyBinding>

move_left_key: InheritableVariable<KeyBinding>

move_right_key: InheritableVariable<KeyBinding>

acceleration_curve: InheritableVariable<Curve>

deceleration_curve: InheritableVariable<Curve>

acceleration_time: InheritableVariable<f32>

deceleration_time: InheritableVariable<f32>

reactivity: InheritableVariable<f32>

velocity: InheritableVariable<Vector3<f32>>

target_velocity: InheritableVariable<Vector3<f32>>

acceleration_coeff: f32

move_forward: bool

move_backward: bool

move_left: bool

move_right: bool

Implementations

impl FlyingCameraController

pub const YAW: &'static str = "yaw"

pub const PITCH: &'static str = "pitch"

pub const SPEED: &'static str = "speed"

pub const SENSITIVITY: &'static str = "sensitivity"

pub const PITCH_LIMIT: &'static str = "pitch_limit"

pub const MOVE_FORWARD_KEY: &'static str = "move_forward_key"

pub const MOVE_BACKWARD_KEY: &'static str = "move_backward_key"

pub const MOVE_LEFT_KEY: &'static str = "move_left_key"

pub const MOVE_RIGHT_KEY: &'static str = "move_right_key"

pub const ACCELERATION_CURVE: &'static str = "acceleration_curve"

pub const DECELERATION_CURVE: &'static str = "deceleration_curve"

pub const ACCELERATION_TIME: &'static str = "acceleration_time"

pub const DECELERATION_TIME: &'static str = "deceleration_time"

pub const REACTIVITY: &'static str = "reactivity"

Trait Implementations

impl Clone for FlyingCameraController

fn clone(&self) -> FlyingCameraController

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ComponentProvider for FlyingCameraController

fn query_component_ref(&self, type_id: TypeId) -> Option<&dyn Any>

Allows an object to provide access to inner components.

fn query_component_mut(&mut self, type_id: TypeId) -> Option<&mut dyn Any>

Allows an object to provide access to inner components.

impl Debug for FlyingCameraController

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

Formats the value using the given formatter.

impl Default for FlyingCameraController

fn default() -> Self

Returns the “default value” for a type.

impl Reflect for FlyingCameraController

where Self: 'static, InheritableVariable<f32>: Reflect, InheritableVariable<Range<f32>>: Reflect, InheritableVariable<KeyBinding>: Reflect, InheritableVariable<Curve>: 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 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 set_field( &mut self, field: &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_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 ScriptTrait for FlyingCameraController

fn on_os_event( &mut self, event: &Event<()>, context: &mut ScriptContext<'_, '_, '_> )

Called when there is an event from the OS. The method allows you to “listen” for events coming from the main window of your game. It could be used to react to pressed keys, mouse movements, etc.

fn on_update(&mut self, context: &mut ScriptContext<'_, '_, '_>)

Performs a single update tick of the script. The method may be called multiple times per frame, but it is guaranteed that the rate of call is stable and by default it will be called 60 times per second, but can be changed by using crate::engine::executor::Executor::set_desired_update_rate method.

fn on_init(&mut self, ctx: &mut ScriptContext<'_, '_, '_>)

The method is called when the script wasn’t initialized yet. It is guaranteed to be called once, and before any other methods of the script.

fn on_start(&mut self, ctx: &mut ScriptContext<'_, '_, '_>)

The method is called after ScriptTrait::on_init, but in separate pass, which means that all script instances are already initialized. However, if implementor of this method creates a new node with a script, there will be a second pass of initialization. The method is guaranteed to be called once.

fn on_deinit(&mut self, ctx: &mut ScriptDeinitContext<'_, '_, '_>)

The method is called when the script is about to be destroyed. It is guaranteed to be called last.

fn on_message( &mut self, message: &mut (dyn ScriptMessagePayload + 'static), ctx: &mut ScriptMessageContext<'_, '_, '_> )

Allows you to react to certain script messages. It could be used for communication between scripts; to bypass borrowing issues. If you need to receive messages of a particular type, you must subscribe to a type explicitly. Usually it is done in ScriptTrait::on_start method:

impl TypeUuidProvider for FlyingCameraController

fn type_uuid() -> Uuid

Return type UUID.

impl Visit for FlyingCameraController

where InheritableVariable<f32>: Visit, InheritableVariable<Range<f32>>: Visit, InheritableVariable<KeyBinding>: Visit, InheritableVariable<Curve>: Visit, InheritableVariable<Vector3<f32>>: Visit,

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.