Skip to main content

Field

Struct Field 

Source
pub struct Field<'a> {
    pub name: &'static str,
    pub value: FieldRef<'a>,
}
Expand description

Named editable property shared by Inspector widgets and scene script properties.

use kvas_engine::reflect::Field;
let mut speed = 2.0;
{ let mut field = Field::f32("speed", &mut speed);
  field.set_json(&serde_json::json!(3.0)); }
assert_eq!(speed, 3.0);

Fields§

§name: &'static str

Stable property key used in scene JSON, undo and the Inspector.

§value: FieldRef<'a>

Borrowed value and editor presentation kind.

Implementations§

Source§

impl<'a> Field<'a>

Source

pub fn f32(name: &'static str, v: &'a mut f32) -> Self

Borrows a floating-point property under a stable field name.

Source

pub fn i32(name: &'static str, v: &'a mut i32) -> Self

Borrows a signed integer property.

Source

pub fn u32(name: &'static str, value: &'a mut u32) -> Self

Borrows an unsigned integer property without narrowing its range to i32.

Source

pub fn bool(name: &'static str, v: &'a mut bool) -> Self

Borrows a boolean checkbox property.

Source

pub fn vec3(name: &'static str, v: &'a mut Vec3) -> Self

Borrows a three-component vector property.

Source

pub fn color(name: &'static str, v: &'a mut [f32; 4]) -> Self

Borrows an RGBA colour property.

Source

pub fn text(name: &'static str, v: &'a mut String) -> Self

Borrows an editable string property.

Source

pub fn asset(name: &'static str, v: &'a mut String, kind: AssetKind) -> Self

Borrows an asset path with the specified picker category.

Source

pub fn entity(name: &'static str, v: &'a mut String) -> Self

Borrows an entity-name reference; names are resolved by gameplay code.

Source

pub fn choice<T: Choice + 'a>(name: &'static str, v: &'a mut T) -> Self

Borrows an enum as a dropdown using its Choice implementation.

Source

pub fn to_json(&self) -> Value

Copies the current reflected value into JSON. Non-finite numeric values serialize as null through serde_json.

Source

pub fn set_json(&mut self, value: &Value)

Applies a JSON value; values of the wrong shape are ignored.

Source

pub fn try_set_json(&mut self, value: &Value) -> bool

Applies a value only if its shape and numeric range match the field. Returns false without mutation for invalid data, unknown choice labels, integer overflow or non-finite float conversions.

Auto Trait Implementations§

§

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

§

impl<'a> !Send for Field<'a>

§

impl<'a> !Sync for Field<'a>

§

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

§

impl<'a> Freeze for Field<'a>

§

impl<'a> Unpin for Field<'a>

§

impl<'a> UnsafeUnpin for Field<'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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.