Struct Model

pub struct Model { /* private fields */ }

See module docs.

Implementations

impl Model

pub const MAPPING: &'static str = "mapping"

pub const SCENE: &'static str = "scene"

impl Model

pub fn new(mapping: NodeMapping, scene: Scene) -> Self

Creates a new Model instance using the given node mapping and the given scene. It could be used to create your own Model resources.

pub fn get_scene(&self) -> &Scene

Returns shared reference to internal scene, there is no way to obtain mutable reference to inner scene because resource is immutable source of data.

pub fn find_node_by_name(&self, name: &str) -> Option<(Handle<Node>, &Node)>

Searches for a node in the model, starting from specified node using the specified closure. Returns a tuple with a handle and a reference to the found node. If nothing is found, it returns None.

Trait Implementations

impl AnimationSource for Model

type Prefab = Model

Prefab type.

type SceneGraph = Graph

Scene graph type.

type Node = Node

Scene node type.

fn inner_graph(&self) -> &Self::SceneGraph

Returns a reference to an inner graph.

fn retarget_animations_directly( &self, root: Handle<Self::Node>, graph: &Self::SceneGraph, self_kind: ResourceKind, ) -> Vec<Animation<Handle<Self::Node>>>

Tries to retarget animations from given model resource to a node hierarchy starting from root on a given scene.

fn retarget_animations_to_player( &self, root: Handle<Self::Node>, dest_animation_player: Handle<Self::Node>, graph: &mut Self::SceneGraph, self_kind: ResourceKind, ) -> Vec<Handle<Animation<Handle<Self::Node>>>>

Tries to retarget animations from given model resource to a node hierarchy starting from root on a given scene. Unlike Self::retarget_animations_directly, it automatically adds retargetted animations to the specified animation player in the hierarchy of given root.

fn retarget_animations( &self, root: Handle<Self::Node>, graph: &mut Self::SceneGraph, self_kind: ResourceKind, ) -> Vec<Handle<Animation<Handle<Self::Node>>>>

Tries to retarget animations from given model resource to a node hierarchy starting from root on a given scene. Unlike Self::retarget_animations_directly, it automatically adds retargetted animations to a first animation player in the hierarchy of given root.

impl Debug for Model

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

Formats the value using the given formatter.

impl Default for Model

fn default() -> Self

Returns the “default value” for a type.

impl PrefabData for Model

type Graph = Graph

fn graph(&self) -> &Self::Graph

fn mapping(&self) -> NodeMapping

impl Reflect for Model

where Self: 'static, NodeMapping: Reflect, Scene: 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 ResourceData for Model

fn type_uuid(&self) -> Uuid

Returns unique data type id.

fn save(&mut self, path: &Path) -> Result<(), Box<dyn Error>>

Saves the resource data a file at the specified path. This method is free to decide how the resource data is saved. This is needed, because there are multiple formats that defines various kinds of resources. For example, a rectangular texture could be saved into a bunch of formats, such as png, bmp, tga, jpg etc., but in the engine it is single Texture resource. In any case, produced file should be compatible with a respective resource loader.

fn can_be_saved(&self) -> bool

Returns true if the resource data can be saved to a file, false - otherwise. Not every resource type supports saving, for example there might be temporary resource type that is used only at runtime which does not need saving at all.

impl TypeUuidProvider for Model

fn type_uuid() -> Uuid

Return type UUID.

impl Visit for Model

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.