Struct fyrox::scene::Scene

pub struct Scene {
    pub graph: Graph,
    pub animations: AnimationContainer,
    pub render_target: Option<Texture>,
    pub drawing_context: SceneDrawingContext,
    pub navmeshes: NavMeshContainer,
    pub performance_statistics: PerformanceStatistics,
    pub ambient_lighting_color: Color,
    pub enabled: bool,
    pub animation_machines: AnimationMachineContainer,
    /* private fields */
}

See module docs.

Fields

graph: Graph

Graph is main container for all scene nodes. It calculates global transforms for nodes, updates them and performs all other important work. See graph module docs for more info.

animations: AnimationContainer

Animations container controls all animation on scene. Each animation can have tracks which has handles to graph nodes. See animation module docs for more info.

render_target: Option<Texture>

Texture to draw scene to. If empty, scene will be drawn on screen directly. It is useful to “embed” some scene into other by drawing a quad with this texture. This can be used to make in-game video conference - you can make separate scene with your characters and draw scene into texture, then in main scene you can attach this texture to some quad which will be used as monitor. Other usage could be previewer of models, like pictogram of character in real-time strategies, in other words there are plenty of possible uses.

drawing_context: SceneDrawingContext

Drawing context for simple graphics.

navmeshes: NavMeshContainer

A container for navigational meshes.

performance_statistics: PerformanceStatistics

Performance statistics from last update call.

ambient_lighting_color: Color

Color of ambient lighting.

enabled: bool

Whether the scene will be updated and rendered or not. Default is true. This flag allowing you to build a scene manager for your game. For example, you may have a scene for menu and one per level. Menu’s scene is persistent, however you don’t want it to be updated and renderer while you have a level loaded and playing a game. When you’re start playing, just set enabled flag to false for menu’s scene and when you need to open a menu - set it to true and set enabled flag to false for level’s scene.

animation_machines: AnimationMachineContainer

A container for animation blending state machines.

Implementations

impl Scene

Property key constants

pub const GRAPH: &'static str = "graph"

pub const AMBIENT_LIGHTING_COLOR: &'static str = "ambient_lighting_color"

pub const ENABLED: &'static str = "enabled"

impl Scene

pub fn new() -> Self

Creates new scene with single root node.

Notes

This method differs from Default trait implementation! Scene::default() creates empty graph with no nodes.

pub fn remove_node(&mut self, handle: Handle<Node>)

Removes node from scene with all associated entities, like animations etc. This method should be used all times instead of Graph::remove_node.

Panics

Panics if handle is invalid.

pub async fn resolve(&mut self, resource_manager: ResourceManager)

Synchronizes the state of the scene with external resources.

pub fn set_lightmap(
    &mut self,
    lightmap: Lightmap
) -> Result<Option<Lightmap>, &'static str>

Tries to set new lightmap to scene.

pub fn update(&mut self, frame_size: Vector2<f32>, dt: f32)

Performs single update tick with given delta time from last frame. Internally it updates physics, animations, and each graph node. In most cases there is no need to call it directly, engine automatically updates all available scenes.

pub fn clone<F>(
    &self,
    filter: &mut F
) -> (Self, FxHashMap<Handle<Node>, Handle<Node>>) where
    F: FnMut(Handle<Node>, &Node) -> bool, 

Creates deep copy of a scene, filter predicate allows you to filter out nodes by your criteria.

pub fn save(&mut self, region_name: &str, visitor: &mut Visitor) -> VisitResult

Saves scene in a specified file.

Trait Implementations

impl Debug for Scene

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

Formats the value using the given formatter.

impl Default for Scene

fn default() -> Self

Returns the “default value” for a type.

impl Inspect for Scene

fn properties(&self) -> Vec<PropertyInfo<'_>>

Returns information about “public” properties.