Struct dae_parser::Effect

pub struct Effect {
    pub id: String,
    pub name: Option<String>,
    pub asset: Option<Box<Asset>>,
    pub annotate: Vec<Annotate>,
    pub image: Vec<Image>,
    pub new_param: Vec<NewParam>,
    pub profile: Vec<Profile>,
    pub extra: Vec<Extra>,
}

Provides a self-contained description of a COLLADA effect.

Fields

id: String

Global identifier for this object.

name: Option<String>

The text string name of this element.

asset: Option<Box<Asset>>

Asset management information about this element.

annotate: Vec<Annotate>

A list of strongly typed annotation remarks.

image: Vec<Image>

Declares a standard COLLADA image resource.

new_param: Vec<NewParam>

Creates a new parameter from a constrained set of types recognizable by all platforms, see ParamType.

profile: Vec<Profile>

At least one profile must appear.

extra: Vec<Extra>

Provides arbitrary additional information about this element.

Implementations

impl Effect

pub fn get_common_profile(&self) -> Option<&ProfileCommon>

Get the first ProfileCommon in this effect.

pub fn get_param(&self, sid: &str) -> Option<&NewParam>

Get a parameter of the effect by name.

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Effect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Effect

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

Formats the value using the given formatter.

impl HasId for Effect

fn id(&self) -> Option<&str>

Get the ID of the node.

fn get_local_map<'a, 'b>(
    maps: &'b LocalMaps<'a>
) -> &'b Option<LocalMap<'a, Self>>

Extract the relevant LocalMap field from a LocalMaps.

fn get_local_map_mut<'a, 'b>(
    maps: &'b mut LocalMaps<'a>
) -> &'b mut Option<LocalMap<'a, Self>>

Extract the relevant LocalMap field from a LocalMaps.

impl Instantiate for Effect

const INSTANCE: &'static str

The name of the instance node. For example Geometry::INSTANCE = "instance_geometry".

type Data = InstanceEffectData

The type of additional data associated with instantiations, possibly ().

fn parse_data(
    _: &Element,
    it: &mut Peekable<Children<'_>>
) -> Result<Self::Data, Error>

Parse the Self::Data given an element iterator, and a reference to the parent element.

impl ParseLibrary for Effect

const LIBRARY: &'static str

The name of the library element. For example, the Geometry element has LIBRARY = "library_geometries", and the corresponding library type is Library<Geometry>.

fn extract_element(e: &LibraryElement) -> Option<&Library<Self>>

Extract the library from a single LibraryElement.

impl Traversable for Effect

fn traverse<'a, E>(
    doc: &'a Document,
    f: impl FnMut(&'a Effect) -> Result<(), E>
) -> Result<(), E>

Run the function f on all elements of type Self in the document doc.

impl XNode for Effect

const NAME: &'static str

The name of the XML element.

fn parse(element: &Element) -> Result<Self, Error>

Parse an XML element into this type. In most cases, the parser will require with a debug_assert that the element to parse has name Self::NAME.

fn parse_box(element: &Element) -> Result<Box<Self>, Error>

Parse an XML element and return the data structure in a Box. This can be faster in some cases when the data structure is large.

fn parse_one<'a>(
    it: &mut impl Iterator<Item = &'a Element>
) -> Result<Self, Error>

Parse a single required element from the given element iterator.

fn parse_opt(it: &mut Peekable<Children<'_>>) -> Result<Option<Self>, Error>

Parse an optional element from the given element iterator, using Self::NAME to determine if it is the correct type.

fn parse_opt_box(
    it: &mut Peekable<Children<'_>>
) -> Result<Option<Box<Self>>, Error>

Parse an optional boxed element from the given element iterator, using Self::NAME to determine if it is the correct type.

fn parse_list(it: &mut Peekable<Children<'_>>) -> Result<Vec<Self>, Error>

Parse a list of elements from the given element iterator, as long as it continues yielding elements of name Self::NAME.

fn parse_list_n<const N: usize>(
    it: &mut Peekable<Children<'_>>
) -> Result<Vec<Self>, Error>

Parse a list of elements from the given element iterator, as long as it continues yielding elements of name Self::NAME, and assert that the resulting list has length at least N.