Skip to main content

Orb

Struct Orb 

Source
pub struct Orb { /* private fields */ }
Expand description

Animated thinking-orb status indicator for AI / agent UIs.

cx.new(|_| Orb::new().state(OrbState::Searching).size(OrbSize::Avatar))

Implementations§

Source§

impl Orb

Source

pub fn new() -> Self

Source

pub fn state(self, state: OrbState) -> Self

Source

pub fn size(self, size: OrbSize) -> Self

Source

pub fn theme(self, theme: OrbTheme) -> Self

Source

pub fn speed(self, speed: f32) -> Self

Source

pub fn paused(self, paused: bool) -> Self

Same clock rules as Self::set_paused: entering pause records paused_at; leaving folds the elapsed pause into paused_total.

Source

pub fn reduced_motion(self, reduced: bool) -> Self

Source

pub fn target_fps(self, fps: f32) -> Self

Cap the redraw rate. Values are clamped to 1.0..=240.0.

Lower is cheaper: cost scales linearly with this number.

Source

pub fn pause_when_inactive(self, pause: bool) -> Self

Whether to freeze while the host window is inactive. Defaults to true.

A background window’s animation is not visible to anyone, so this is usually free. Set it to false if the orb must keep moving in a window that is visible but unfocused — a side panel, or a floating HUD.

Source

pub fn visible(self, visible: bool) -> Self

Whether the host considers this orb on-screen. Defaults to true.

gpui has no intersection observer. When you keep the entity mounted in a scrollable list but it has scrolled away, call Self::set_visible(false) (or build with .visible(false)) so the timer stops. Prefer unmounting when you can.

Source

pub fn set_state(&mut self, state: OrbState, cx: &mut Context<'_, Self>)

Mutable setters for interactive playgrounds.

Source

pub fn set_size(&mut self, size: OrbSize, cx: &mut Context<'_, Self>)

Source

pub fn set_theme(&mut self, theme: OrbTheme, cx: &mut Context<'_, Self>)

Source

pub fn set_speed(&mut self, speed: f32, cx: &mut Context<'_, Self>)

Source

pub fn set_paused(&mut self, paused: bool, cx: &mut Context<'_, Self>)

Source

pub fn set_reduced_motion(&mut self, reduced: bool, cx: &mut Context<'_, Self>)

Source

pub fn set_target_fps(&mut self, fps: f32, cx: &mut Context<'_, Self>)

Source

pub fn set_pause_when_inactive( &mut self, pause: bool, cx: &mut Context<'_, Self>, )

Source

pub fn set_visible(&mut self, visible: bool, cx: &mut Context<'_, Self>)

Host visibility gate — see Self::visible.

Source

pub fn state_value(&self) -> OrbState

Source

pub fn size_value(&self) -> OrbSize

Source

pub fn theme_value(&self) -> OrbTheme

Source

pub fn speed_value(&self) -> f32

Source

pub fn is_paused(&self) -> bool

Source

pub fn reduced_motion_value(&self) -> bool

Source

pub fn target_fps_value(&self) -> f32

Source

pub fn pause_when_inactive_value(&self) -> bool

Source

pub fn is_visible(&self) -> bool

Trait Implementations§

Source§

impl Default for Orb

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Render for Orb

Source§

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Orb

§

impl !Send for Orb

§

impl !Sync for Orb

§

impl !UnwindSafe for Orb

§

impl Freeze for Orb

§

impl Unpin for Orb

§

impl UnsafeUnpin for Orb

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more