Struct PropertyInfo

pub struct PropertyInfo {
    pub group: NestGroup,
    pub capture: bool,
    pub id: PropertyId,
    pub name: &'static str,
    pub location: SourceLocation,
    pub default: Option<fn() -> Box<dyn PropertyArgs>>,
    pub new: fn(_: PropertyNewArgs) -> Box<dyn PropertyArgs>,
    pub inputs: Box<[PropertyInput]>,
}

Property info.

You can use the property_info! macro to retrieve a property’s info.

Fields

group: NestGroup

Property nest position group.

capture: bool

Property is “capture-only”, no standalone implementation is provided, instantiating does not add a node, just returns the child.

Note that all properties can be captured, but if this is false they provide an implementation that works standalone.

id: PropertyId

Unique ID that identifies the property implementation.

name: &'static str

Property name.

location: SourceLocation

Property declaration location.

default: Option<fn() -> Box<dyn PropertyArgs>>

New default property args.

This is Some(_) only if the #[property(_, default(..))] was set in the property declaration.

new: fn(_: PropertyNewArgs) -> Box<dyn PropertyArgs>

New property args from dynamically typed args.

Instance

This function outputs property args, not a property node instance. You can use PropertyArgs::instantiate on the output to generate a property node from the args. If the property is known at compile time you can use property_args! to generate args instead, and you can just call the property function directly to instantiate a node.

inputs: Box<[PropertyInput]>

Property inputs info.

Implementations

impl PropertyInfo

pub fn input_idx(&self, name: &str) -> Option<usize>

Gets the index that can be used to get a named property input value in PropertyArgs.

Trait Implementations

impl Clone for PropertyInfo

fn clone(&self) -> PropertyInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PropertyInfo

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

Formats the value using the given formatter.