Struct AssetParm

Source
pub struct AssetParm<'a> { /* private fields */ }
Expand description

Holds info and default value of a parameter

Implementations§

Source§

impl<'a> AssetParm<'a>

Source

pub fn default_value(&self) -> ParmValue<'a>

Get parameter default value

Source

pub fn menu_items(&self) -> Option<&[ParmChoiceInfo]>

Returns menu parameter items. Note, dynamic(script) menus should be queried directly from a node.

Source

pub fn get_tag(&self, tag_index: i32) -> Result<(String, String)>

Get asset parameter tag name and value

Methods from Deref<Target = ParmInfo>§

Source

pub fn id(&self) -> ParmHandle

Source

pub fn parent_id(&self) -> ParmHandle

Source

pub fn child_index(&self) -> i32

Source

pub fn parm_type(&self) -> ParmType

Source

pub fn script_type(&self) -> PrmScriptType

Source

pub fn permissions(&self) -> Permissions

Source

pub fn tag_count(&self) -> i32

Source

pub fn size(&self) -> i32

Source

pub fn choice_count(&self) -> i32

Source

pub fn choice_list_type(&self) -> ChoiceListType

Source

pub fn has_min(&self) -> bool

Source

pub fn has_max(&self) -> bool

Source

pub fn has_uimin(&self) -> bool

Source

pub fn has_uimax(&self) -> bool

Source

pub fn min(&self) -> f32

Source

pub fn max(&self) -> f32

Source

pub fn uimin(&self) -> f32

Source

pub fn uimax(&self) -> f32

Source

pub fn invisible(&self) -> bool

Source

pub fn disabled(&self) -> bool

Source

pub fn spare(&self) -> bool

Source

pub fn join_next(&self) -> bool

Source

pub fn label_none(&self) -> bool

Source

pub fn int_values_index(&self) -> i32

Source

pub fn float_values_index(&self) -> i32

Source

pub fn string_values_index(&self) -> i32

Source

pub fn choice_index(&self) -> i32

Source

pub fn input_node_type(&self) -> NodeType

Source

pub fn input_node_flag(&self) -> NodeFlags

Source

pub fn is_child_of_multi_parm(&self) -> bool

Source

pub fn instance_num(&self) -> i32

Source

pub fn instance_length(&self) -> i32

Source

pub fn instance_count(&self) -> i32

Source

pub fn instance_start_offset(&self) -> i32

Source

pub fn ramp_type(&self) -> RampType

Source

pub fn type_info(&self) -> Result<String>

Source

pub fn name(&self) -> Result<String>

Source

pub fn name_cstr(&self) -> Result<CString>

Source

pub fn label(&self) -> Result<String>

Source

pub fn template_name(&self) -> Result<String>

Source

pub fn help(&self) -> Result<String>

Source

pub fn visibility_condition(&self) -> Result<String>

Source

pub fn disabled_condition(&self) -> Result<String>

Trait Implementations§

Source§

impl Deref for AssetParm<'_>

Source§

type Target = ParmInfo

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

§

impl<'a> Freeze for AssetParm<'a>

§

impl<'a> !RefUnwindSafe for AssetParm<'a>

§

impl<'a> Send for AssetParm<'a>

§

impl<'a> Sync for AssetParm<'a>

§

impl<'a> Unpin for AssetParm<'a>

§

impl<'a> !UnwindSafe for AssetParm<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.