Struct bevy::gizmos::prelude::GizmoConfig

pub struct GizmoConfig {
    pub enabled: bool,
    pub line_width: f32,
    pub line_perspective: bool,
    pub depth_bias: f32,
    pub render_layers: RenderLayers,
}

A struct that stores configuration for gizmos.

Fields

enabled: bool

Set to false to stop drawing gizmos.

Defaults to true.

line_width: f32

Line width specified in pixels.

If line_perspective is true then this is the size in pixels at the camera’s near plane.

Defaults to 2.0.

line_perspective: bool

Apply perspective to gizmo lines.

This setting only affects 3D, non-orthographic cameras.

Defaults to false.

depth_bias: f32

How closer to the camera than real geometry the line 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 line 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.

render_layers: RenderLayers

Describes which rendering layers gizmos will be rendered to.

Gizmos will only be rendered to cameras with intersecting layers.

Trait Implementations

impl Clone for GizmoConfig

fn clone(&self) -> GizmoConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for GizmoConfig

fn default() -> GizmoConfig

Returns the “default value” for a type.

impl FromReflect for GizmoConfig

where GizmoConfig: Any + Send + Sync, bool: FromReflect + TypePath, f32: FromReflect + TypePath, RenderLayers: FromReflect + TypePath,

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<GizmoConfig>

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for GizmoConfig

where GizmoConfig: Any + Send + Sync, bool: FromReflect + TypePath, f32: FromReflect + TypePath, RenderLayers: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for GizmoConfig

where GizmoConfig: Any + Send + Sync, bool: FromReflect + TypePath, f32: FromReflect + TypePath, RenderLayers: FromReflect + TypePath,

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

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<GizmoConfig>) -> 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<GizmoConfig>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

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

Casts this type to a reflected value.

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

Casts this type to a mutable reflected value.

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

Clones the value as a Reflect trait object.

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

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

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

Applies 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<GizmoConfig>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

Returns a “partial equality” comparison result.

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 serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for GizmoConfig

where GizmoConfig: Any + Send + Sync, bool: FromReflect + TypePath, f32: FromReflect + TypePath, RenderLayers: FromReflect + TypePath,

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

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

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

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

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

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

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

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

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 clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for GizmoConfig

where GizmoConfig: 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 GizmoConfig

where GizmoConfig: Any + Send + Sync, bool: FromReflect + TypePath, f32: FromReflect + TypePath, RenderLayers: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.