Struct ambient_api::core::camera::concepts::PerspectiveCommonCameraOptional

pub struct PerspectiveCommonCameraOptional {
    pub translation: Option<Vec3>,
    pub rotation: Option<Quat>,
    pub scale: Option<Vec3>,
    pub main_scene: Option<()>,
    pub ui_scene: Option<()>,
    pub user_id: Option<String>,
    pub aspect_ratio_from_window: Option<EntityId>,
}

Optional part of PerspectiveCommonCamera.

Fields

translation: Option<Vec3>

Component: ambient_core::transform::translation

Suggested value: Vec3::new(0f32, 0f32, 0f32, )

Component description: The translation/position of this entity.

rotation: Option<Quat>

Component: ambient_core::transform::rotation

Suggested value: Quat::from_xyzw(0f32, 0f32, 0f32, 1f32, )

Component description: The rotation of this entity.

scale: Option<Vec3>

Component: ambient_core::transform::scale

Suggested value: Vec3::new(1f32, 1f32, 1f32, )

Component description: The scale of this entity.

main_scene: Option<()>

Component: ambient_core::app::main_scene

Description: Either the main or UI scene must be specified for this camera to be used.

Component description: If attached, this entity belongs to the main scene.

ui_scene: Option<()>

Component: ambient_core::app::ui_scene

Description: Either the main or UI scene must be specified for this camera to be used.

Component description: If attached, this entity belongs to the UI scene.

user_id: Option<String>

Component: ambient_core::player::user_id

Description: If set, this camera will only be used for the specified user.

Component description: An identifier attached to all things owned by a user, and supplied by the user. This can be attached to more than just the player; by convention, it is also attached to related entities, including their camera and body.

aspect_ratio_from_window: Option<EntityId>

Component: ambient_core::camera::aspect_ratio_from_window

Component description: If attached, the aspect_ratio component will be automatically updated to match the aspect ratio of the window. Should point to an entity with a window_physical_size component.

Trait Implementations

impl Clone for PerspectiveCommonCameraOptional

fn clone(&self) -> PerspectiveCommonCameraOptional

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PerspectiveCommonCameraOptional

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

Formats the value using the given formatter.

impl Default for PerspectiveCommonCameraOptional

fn default() -> PerspectiveCommonCameraOptional

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PerspectiveCommonCameraOptional

fn deserialize<__D>( __deserializer: __D ) -> Result<PerspectiveCommonCameraOptional, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PerspectiveCommonCameraOptional

fn eq(&self, other: &PerspectiveCommonCameraOptional) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PerspectiveCommonCameraOptional

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PerspectiveCommonCameraOptional