Struct FramingOptions 

pub struct FramingOptions { /* private fields */ }

Options for fitting a camera to world-space bounds.

Implementations

impl FramingOptions

pub const PRESET_NAMES: &'static [&'static str]

pub fn from_preset_name(name: &str) -> Option<Self>

pub const fn new() -> Self

Creates perspective framing options with conservative defaults.

pub const fn view_direction(self, view_direction: Vec3) -> Self

Sets the world-space direction from the target toward the camera.

pub const fn look_from(self, direction: Vec3) -> Self

Alias for Self::view_direction that reads naturally at call sites.

pub fn azimuth_elevation(self, azimuth_deg: f32, elevation_deg: f32) -> Self

Place the camera by azimuth and elevation in degrees.

Conventions:

• azimuth_deg is the horizontal angle from the +Z front axis. Positive rotates toward +X (right); negative toward -X (left). 0 deg = front, 90 deg = right, +-180 deg = back, -90 deg = left.
• elevation_deg is the vertical angle from the horizon. Positive is above, negative is below. Values are clamped to [-90.0, 90.0].

Equivalent to calling look_from with a unit direction derived from spherical coordinates.

Examples

use scena::FramingOptions;

// 28 degrees to the left of front, 18 degrees above horizon.
let _options = FramingOptions::new().azimuth_elevation(-28.0, 18.0);

pub fn front(self) -> Self

Looks at the bounds from the positive Z direction.

Places the camera in front of the target, on the +Z world axis, looking toward -Z.

Examples

use scena::FramingOptions;

let _options = FramingOptions::new().front();

pub fn back(self) -> Self

Place the camera behind the target.

Places the camera on the -Z world axis, looking toward +Z.

Examples

use scena::FramingOptions;

let _options = FramingOptions::new().back();

pub fn right(self) -> Self

Place the camera to the right of the target.

Places the camera on the +X world axis.

Examples

use scena::FramingOptions;

let _options = FramingOptions::new().right();

pub fn left(self) -> Self

Place the camera to the left of the target.

Places the camera on the -X world axis.

Examples

use scena::FramingOptions;

let _options = FramingOptions::new().left();

pub fn top(self) -> Self

Place the camera above the target.

Places the camera on the +Y world axis, looking down.

Examples

use scena::FramingOptions;

let _options = FramingOptions::new().top();

pub fn bottom(self) -> Self

Place the camera below the target.

Places the camera on the -Y world axis, looking up.

Examples

use scena::FramingOptions;

let _options = FramingOptions::new().bottom();

pub const fn isometric(self) -> Self

Looks at the bounds from a generic isometric-style direction.

pub fn three_quarter_front_right(self) -> Self

Three-quarter view from the front-right, slightly elevated.

Equivalent to azimuth_elevation(45.0, 30.0).

Examples

use scena::FramingOptions;

let _options = FramingOptions::new().three_quarter_front_right();

pub fn three_quarter_front_left(self) -> Self

Three-quarter view from the front-left, slightly elevated.

Equivalent to azimuth_elevation(-45.0, 30.0).

Examples

use scena::FramingOptions;

let _options = FramingOptions::new().three_quarter_front_left();

pub fn three_quarter_back_right(self) -> Self

Three-quarter view from the back-right, slightly elevated.

Equivalent to azimuth_elevation(135.0, 30.0).

Examples

use scena::FramingOptions;

let _options = FramingOptions::new().three_quarter_back_right();

pub fn three_quarter_back_left(self) -> Self

Three-quarter view from the back-left, slightly elevated.

Equivalent to azimuth_elevation(-135.0, 30.0).

Examples

use scena::FramingOptions;

let _options = FramingOptions::new().three_quarter_back_left();

pub fn orbit(self, yaw_radians: f32, pitch_radians: f32) -> Self

Sets the view direction from turntable yaw and pitch radians.

pub const fn up(self, up: Vec3) -> Self

Sets the camera up vector used by the framing solver.

pub const fn fill(self, fill: f32) -> Self

Sets the requested maximum viewport fill fraction.

pub const fn margin_px(self, margin_px: f32) -> Self

Sets the viewport margin in pixels.

pub const fn viewport(self, width: u32, height: u32) -> Self

Sets the viewport size in physical pixels.

pub const fn tighten_depth_range(self, enabled: bool) -> Self

Enables near/far tightening when the caller has verified it is safe.

Trait Implementations

impl Clone for FramingOptions

fn clone(&self) -> FramingOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FramingOptions

impl Debug for FramingOptions

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

Formats the value using the given formatter.

impl Default for FramingOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for FramingOptions

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for FramingOptions