Struct SurfacePointer 

pub struct SurfacePointer {
    pub surface: String,
    pub uv_channel: UvChannel,
}

App-facing marker: put this on the 3D entity (mesh) that displays a surface’s texture, naming the surface it shows. drive_surface_pointer ray-casts these meshes so clicking them drives the surface’s React UI. The mesh must have UVs.

uv_channel selects which of the mesh’s UV sets the surface texture is mapped to — picking reads the in-world hit’s UV from the same channel so clicks land on the right pixel. Set it to match the *_channel you bound the surface texture to on the material (e.g. a dedicated UvChannel::Uv1 for the UI, leaving UvChannel::Uv0 for the model’s own maps). Defaults to UvChannel::Uv0.

Fields

surface: String

The surface (registry key) whose texture this mesh displays.

uv_channel: UvChannel

Which mesh UV set the surface texture (and picking) uses.

Implementations

impl SurfacePointer

pub fn new(surface: impl Into<String>) -> Self

Mark a mesh as displaying surface, with the UI on UvChannel::Uv0.

pub fn with_uv_channel(self, channel: UvChannel) -> Self

Map the surface texture (and picking) to a specific UV set.

Trait Implementations

impl Clone for SurfacePointer

fn clone(&self) -> SurfacePointer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for SurfacePointer

where Self: Send + Sync + 'static,

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, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

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 relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

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_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard 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 SurfacePointer

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

Formats the value using the given formatter.