Struct Gizmo

pub struct Gizmo {
    pub handle: Handle<GizmoAsset>,
    pub line_config: GizmoLineConfig,
    pub depth_bias: f32,
}

A component that draws the gizmos of a GizmoAsset.

When drawing a greater number of static lines a Gizmo component can have far better performance than the Gizmos system parameter, but the system parameter will perform better for smaller lines that update often.

Example

fn system(
    mut commands: Commands,
    mut gizmo_assets: ResMut<Assets<GizmoAsset>>,
) {
    let mut gizmo = GizmoAsset::default();

    gizmo.sphere(Vec3::ZERO, 1., RED);

    commands.spawn(Gizmo {
        handle: gizmo_assets.add(gizmo),
        line_config: GizmoLineConfig {
            width: 4.,
            ..default()
        },
        ..default()
    });
}

Fields

handle: Handle<GizmoAsset>

The handle to the gizmo to draw.

line_config: GizmoLineConfig

The line specific configuration for this gizmo.

depth_bias: f32

How closer to the camera than real geometry the gizmo should be.

In 2D this setting has no effect and is effectively always -1.

Value between -1 and 1 (inclusive).

• 0 means that there is no change to the gizmo position when rendering
• 1 means it is furthest away from camera as possible
• -1 means that it will always render in front of other things.

This is typically useful if you are drawing wireframes on top of polygons and your wireframe is z-fighting (flickering on/off) with your main model. You would set this value to a negative number close to 0.

Trait Implementations

impl Clone for Gizmo

fn clone(&self) -> Gizmo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Gizmo

where Gizmo: Send + Sync + 'static,

Required Components: Transform.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for Gizmo

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

Formats the value using the given formatter.

impl Default for Gizmo

fn default() -> Gizmo

Returns the “default value” for a type.

impl FromArg for &'static Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = &'from_arg Gizmo

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static Gizmo as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromArg for &'static mut Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = &'from_arg mut Gizmo

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static mut Gizmo as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromArg for Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = Gizmo

The type to convert into.

fn from_arg(arg: Arg<'_>) -> Result<<Gizmo as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &(dyn PartialReflect + 'static)) -> Option<Gizmo>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetOwnership for &Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetOwnership for &mut Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetOwnership for Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoReturn for &Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where &Gizmo: 'into_return,

Converts Self into a Return value.

impl IntoReturn for &mut Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where &mut Gizmo: 'into_return,

Converts Self into a Return value.

impl IntoReturn for Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where Gizmo: 'into_return,

Converts Self into a Return value.

impl PartialReflect for Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Gizmo>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Gizmo>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Gizmo>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the value as a Box<dyn Any>.

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Gizmo>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Struct for Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for Gizmo

where Gizmo: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Gizmo

where Gizmo: Any + Send + Sync, Handle<GizmoAsset>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, GizmoLineConfig: FromReflect + TypePath + MaybeTyped + RegisterForReflection, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.