Struct ambient_api::core::camera::concepts::PerspectiveCommonCamera

pub struct PerspectiveCommonCamera {
    pub local_to_world: Mat4,
    pub near: f32,
    pub projection: Mat4,
    pub projection_view: Mat4,
    pub active_camera: f32,
    pub inv_local_to_world: Mat4,
    pub fovy: f32,
    pub aspect_ratio: f32,
    pub optional: PerspectiveCommonCameraOptional,
}

Perspective Common Camera: Base components for a perspective camera. Consider perspective_camera or perspective_infinite_reverse_camera.

Extends: ambient_core::camera::Camera

Required:

• local_to_world: Transformation from the entity’s local space to worldspace.
• near: The near plane of this camera, measured in meters.
• projection: The projection matrix of this camera. This can be driven by other components, including perspective and perspective_infinite_reverse.
• projection_view: The composition of the projection and view (inverse-local-to-world) matrices.
• active_camera: The camera with the highest active_camera value will be used for rendering. Cameras are also filtered by the user_id. If there’s no user_id, the camera is considered global and potentially applies to all users (if its active_camera value is high enough).
• inv_local_to_world: Converts a world position to a local position. This is automatically updated.
• fovy: The field of view of this camera in the Y/vertical direction, measured in radians.
• aspect_ratio: The aspect ratio of this camera. If aspect_ratio_from_window is set, this will be automatically updated to match the window.

Optional:

• translation: The translation/position of this entity.
• rotation: The rotation of this entity.
• scale: The scale of this entity.
• main_scene: Either the main or UI scene must be specified for this camera to be used.
• ui_scene: Either the main or UI scene must be specified for this camera to be used.
• user_id: If set, this camera will only be used for the specified user.
• aspect_ratio_from_window: 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.

Fields

local_to_world: Mat4

Component: ambient_core::transform::local_to_world

Suggested value: Mat4::from_cols_array(&[1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, ])

Component description: Transformation from the entity’s local space to worldspace.

near: f32

Component: ambient_core::camera::near

Suggested value: 0.1f32

Component description: The near plane of this camera, measured in meters.

projection: Mat4

Component: ambient_core::camera::projection

Suggested value: Mat4::from_cols_array(&[1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, ])

Component description: The projection matrix of this camera. This can be driven by other components, including perspective and perspective_infinite_reverse.

projection_view: Mat4

Component: ambient_core::camera::projection_view

Suggested value: Mat4::from_cols_array(&[1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, ])

Component description: The composition of the projection and view (inverse-local-to-world) matrices.

active_camera: f32

Component: ambient_core::camera::active_camera

Suggested value: 0f32

Component description: The camera with the highest active_camera value will be used for rendering. Cameras are also filtered by the user_id. If there’s no user_id, the camera is considered global and potentially applies to all users (if its active_camera value is high enough).

inv_local_to_world: Mat4

Component: ambient_core::transform::inv_local_to_world

Suggested value: Mat4::from_cols_array(&[1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, ])

Component description: Converts a world position to a local position. This is automatically updated.

fovy: f32

Component: ambient_core::camera::fovy

Suggested value: 1f32

Component description: The field of view of this camera in the Y/vertical direction, measured in radians.

aspect_ratio: f32

Component: ambient_core::camera::aspect_ratio

Suggested value: 1f32

Component description: The aspect ratio of this camera. If aspect_ratio_from_window is set, this will be automatically updated to match the window.

optional: PerspectiveCommonCameraOptional

Optional components.

Trait Implementations

impl Clone for PerspectiveCommonCamera

fn clone(&self) -> PerspectiveCommonCamera

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Concept for PerspectiveCommonCamera

fn make(self) -> Entity

Creates an entity with the components defined by this concept.

fn get_spawned(id: EntityId) -> Option<PerspectiveCommonCamera>

If the entity with id exists and has the components defined by this concept, returns this concept with all of the values of the components in the entity.

fn get_unspawned(entity: &Entity) -> Option<PerspectiveCommonCamera>

If the entity has the components defined by this concept, returns this concept with all of the values of the components in the entity.

fn contained_by_spawned(id: EntityId) -> bool

Returns true if id exists and contains the components defined by this concept.

fn contained_by_unspawned(entity: &Entity) -> bool

Returns true if contains the components defined by this concept.

fn spawn(self) -> EntityId

where Self: Sized,

Spawns this concept into the world. If you want to modify state before spawning, use make instead.

impl ConceptComponents for PerspectiveCommonCamera

type Required = (Component<Mat4>, Component<f32>, Component<Mat4>, Component<Mat4>, Component<f32>, Component<Mat4>, Component<f32>, Component<f32>)

A tuple of the required components for this concept.

type Optional = (Component<Vec3>, Component<Quat>, Component<Vec3>, Component<()>, Component<()>, Component<String>, Component<EntityId>)

A tuple of the optional components for this concept.

fn required() -> <PerspectiveCommonCamera as ConceptComponents>::Required

Returns a tuple of the required components for this concept.

fn optional() -> <PerspectiveCommonCamera as ConceptComponents>::Optional

Returns a tuple of the optional components for this concept.

fn from_required_data( required: <<PerspectiveCommonCamera as ConceptComponents>::Required as ComponentsTuple>::Data ) -> PerspectiveCommonCamera

Converts a tuple of data back to a concept.

fn as_query() -> ConceptQuery<Self>

where Self: Sized,

Creates a ConceptQuery that can be passed into queries.

impl ConceptSuggested for PerspectiveCommonCamera

fn suggested() -> PerspectiveCommonCamera

local_to_world: Mat4::from_cols_array(&[1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, ]),
near: 0.1f32,
projection: Mat4::from_cols_array(&[1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, ]),
projection_view: Mat4::from_cols_array(&[1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, ]),
active_camera: 0f32,
inv_local_to_world: Mat4::from_cols_array(&[1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, 0f32, 0f32, 0f32, 0f32, 1f32, ]),
fovy: 1f32,
aspect_ratio: 1f32,

impl Debug for PerspectiveCommonCamera

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PerspectiveCommonCamera

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PerspectiveCommonCamera

fn eq(&self, other: &PerspectiveCommonCamera) -> 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 PerspectiveCommonCamera

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 PerspectiveCommonCamera