Struct fyrox::gui::inspector::editors::PropertyEditorDefinitionContainer

pub struct PropertyEditorDefinitionContainer {
    pub context_type_id: Mutex<RawMutex, TypeId>,
    /* private fields */
}

This is a list of PropertyEditorDefinition which is indexed by the type that each editor edits, as specified by PropertyEditorDefinition::value_type_id. It also records where each entry in the list came from so that it can know whether a property editor is built-in to the Fyroxed or whether it was added by a plugin. This allows entries to be removed when a plugin is unloaded.

Fields

context_type_id: Mutex<RawMutex, TypeId>

A type representing the source of PropertyEditorDefinitions that are added in the future. For each added PropertyEditorDefinition entry, PropertyEditorDefinitionContainerEntry::source_type_id is set equal to this TypeId. By default this begins as ().type_id(), and then it can be modified with a plugin is loaded to cause all definitions added after that point to be marked as being from that plugin.

Implementations

impl PropertyEditorDefinitionContainer

pub fn empty() -> PropertyEditorDefinitionContainer

pub fn with_default_editors() -> PropertyEditorDefinitionContainer

A container with property editors for Fyrox core types and Rust standard types.

pub fn insert_raw( &self, definition: Box<dyn PropertyEditorDefinition>, ) -> Option<PropertyEditorDefinitionContainerEntry>

Add an already boxed dynamic PropertyEditorDefinition to the list. If this container already had a PropertyEditorDefinition for the same type, the old property editor is removed and returned.

pub fn merge(&self, other: PropertyEditorDefinitionContainer)

Consume a given collection of property editors and add each entry into this collection. Every entry from the given collection is marked as having the current source type; whatever sources they may have had in their original container is forgotten.

pub fn insert<T>( &self, definition: T, ) -> Option<PropertyEditorDefinitionContainerEntry>

where T: PropertyEditorDefinition + 'static,

Move a PropertyEditorDefinition into the list, where it will automatically be boxed. If this container already had a PropertyEditorDefinition for the same type, the old property editor is removed and returned.

pub fn register_inheritable_vec_collection<T>(&self)

where T: CollectionItem + FieldValue,

Inserts the default property editor for Vec<T> and InheritableVariable<Vec<T>>. Panic if these types already have editor definitions.

pub fn register_inheritable_inspectable<T>(&self)

where T: Reflect + FieldValue,

Insert a InspectablePropertyEditorDefinition for the given type. This is a creates a generic property editor that is just a nested inspector for the properties of the value, with an Expander to allow the inner inspector to be hidden.

A property editor definition for InheritableVariable<T> is also inserted.

Panic if these types already have editor definitions.

pub fn register_inheritable_enum<T, E>(&self)

where E: Debug, T: InspectableEnum + FieldValue + VariantNames + AsRef<str> + FromStr<Err = E> + Debug,

Insert property editor definitions to allow enum T to be edited using a dropdown list, as well as InheritableVariable<T>.

Panic if these types already have editor definitions.

pub fn register_inheritable_option<T>(&self)

where T: InspectableEnum + FieldValue + Default,

Insert property editor definitions to allow Option<T> to be edited as well as InheritableVariable<T>.

Panic if these types already have editor definitions.

pub fn definitions( &self, ) -> RwLockReadGuard<'_, RawRwLock, HashMap<TypeId, PropertyEditorDefinitionContainerEntry, BuildHasherDefault<FxHasher>>>

Direct read-only access to all the editor definitions.

pub fn definitions_mut( &self, ) -> RwLockWriteGuard<'_, RawRwLock, HashMap<TypeId, PropertyEditorDefinitionContainerEntry, BuildHasherDefault<FxHasher>>>

Direct and unrestricted access to all the editor definitions.

Trait Implementations

impl Debug for PropertyEditorDefinitionContainer

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

Formats the value using the given formatter.

impl Default for PropertyEditorDefinitionContainer

fn default() -> PropertyEditorDefinitionContainer

Returns the “default value” for a type.