Struct VpeolCameraState

pub struct VpeolCameraState {
    pub cursor_ray: Option<Ray3d>,
    pub entity_under_cursor: Option<(Entity, VpeolCursorPointing)>,
    pub entities_of_interest: HashMap<Entity, Option<VpeolCursorPointing>>,
    pub clicks_on_objects_state: VpeolClicksOnObjectsState,
}

Data passed between Vpeol abstraction and backends.

Fields

cursor_ray: Option<Ray3d>

Where this camera considers the cursor to be in the world.

entity_under_cursor: Option<(Entity, VpeolCursorPointing)>

The topmost entity being pointed by the cursor.

entities_of_interest: HashMap<Entity, Option<VpeolCursorPointing>>

Entities that may or may not be topmost, but the editor needs to know whether or not they are pointed at.

clicks_on_objects_state: VpeolClicksOnObjectsState

The mouse selection state.

Implementations

impl VpeolCameraState

pub fn consider( &mut self, entity: Entity, z_depth_screen_coords: f32, cursor_position_world_coords: impl FnOnce() -> Vec3, )

Tell Vpeol the the user is pointing at an entity.

This function may ignore the input if the entity is covered by another entity and is not an entity of interest.

pub fn pointing_at_entity(&self, entity: Entity) -> Option<&VpeolCursorPointing>

Trait Implementations

impl Component for VpeolCameraState

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 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 VpeolCameraState

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

Formats the value using the given formatter.

impl Default for VpeolCameraState

fn default() -> VpeolCameraState

Returns the “default value” for a type.