Skip to main content

Pointer

Struct Pointer 

Source
pub struct Pointer {
Show 14 fields pub size: f32, pub tone: PointerTone, pub color: Option<String>, pub outline_color: Option<String>, pub click_ring: ClickRing, pub ring_color: Option<String>, pub path: Vec<CursorWaypoint>, pub click_at: Vec<f64>, pub click_duration: f32, pub path_easing: CursorPathEasing, pub timing: TimingConfig, pub style: CssStyle, pub timeline: Vec<TimelineStep>, pub stagger: Option<f32>,
}
Expand description

A mouse pointer that travels a waypoint path and clicks along the way.

Fields§

§size: f32

Height of the arrow in px. The click ring scales with it.

§tone: PointerTone

Colour scheme. Overridden by color / outline_color when set.

§color: Option<String>

Arrow fill (hex), overriding tone.

§outline_color: Option<String>

Arrow outline (hex), overriding tone.

§click_ring: ClickRing

Click ring size. none removes it.

§ring_color: Option<String>

Ring colour (hex). Defaults to the arrow’s fill.

§path: Vec<CursorWaypoint>

Waypoints the pointer travels between, in scene-local seconds. Each x/y is relative to the component’s own origin — place the component with position: absolute and read the waypoints as scene coordinates. The pointer clicks on arrival at each one.

§click_at: Vec<f64>

Extra click times (seconds), for a pointer that clicks without travelling. Ignored when path is set — the waypoints carry their own clicks.

§click_duration: f32

How long one click animation runs (seconds). Also how long the pointer pauses on a waypoint before setting off for the next.

§path_easing: CursorPathEasing

Easing between waypoints.

§timing: TimingConfig§style: CssStyle§timeline: Vec<TimelineStep>§stagger: Option<f32>

Trait Implementations§

Source§

impl Animatable for Pointer

Source§

fn animation_effects(&self) -> &[AnimationEffect]

Source§

fn timeline_steps(&self) -> &[TimelineStep]

Timed animation steps (timeline field): each step’s animations are resolved with delay += step.at. Empty by default.
Source§

impl Debug for Pointer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Pointer

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for Pointer

Source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more
Source§

impl Painter for Pointer

Source§

fn paint_content( &self, canvas: &Canvas, _layout: &BoxLayout, _props: &AnimatedProperties, ctx: &PaintCtx, )

Paint the component’s content into the canvas. The canvas is already translated to the content-box origin and clipped if overflow: hidden was set. Generic decorations (bg, border, shadow) are already painted by the engine. Read more
Source§

fn intrinsic_size( &self, _available: AvailableSize, _ctx: &MeasureCtx, ) -> Option<(f32, f32)>

Optional intrinsic measurement for leaves like text, image, codeblock. Return None to let taffy compute the size from the CSS style alone. available mirrors taffy’s AvailableSpace.
Source§

impl Serialize for Pointer

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Styled for Pointer

Source§

impl StyledMut for Pointer

Source§

fn style_config_mut(&mut self) -> &mut CssStyle

Source§

impl Timed for Pointer

Source§

fn timing(&self) -> (Option<f64>, Option<f64>)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.