Skip to main content

FloatingScalarImage

polyscope_structures::floating

Struct FloatingScalarImage 

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

A floating scalar image quantity (not attached to any structure).

Displays a 2D grid of scalar values using a colormap.

Implementations§

Source§

impl FloatingScalarImage

Source

pub fn new( name: impl Into<String>, width: u32, height: u32, values: Vec<f32>, ) -> Self

Creates a new floating scalar image.

Source

pub fn width(&self) -> u32

Returns the image width.

Source

pub fn height(&self) -> u32

Returns the image height.

Source

pub fn values(&self) -> &[f32]

Returns the scalar values.

Source

pub fn origin(&self) -> ImageOrigin

Gets the image origin.

Source

pub fn set_origin(&mut self, origin: ImageOrigin) -> &mut Self

Sets the image origin.

Source

pub fn colormap_name(&self) -> &str

Gets the colormap name.

Source

pub fn set_colormap(&mut self, name: impl Into<String>) -> &mut Self

Sets the colormap name.

Source

pub fn data_min(&self) -> f32

Gets the data range minimum.

Source

pub fn data_max(&self) -> f32

Gets the data range maximum.

Source

pub fn set_data_range(&mut self, min: f32, max: f32) -> &mut Self

Sets the data range.

Source

pub fn pixel(&self, x: u32, y: u32) -> f32

Returns the pixel value at (x, y), accounting for image origin.

Trait Implementations§

Source§

impl Quantity for FloatingScalarImage

Source§

fn as_any(&self) -> &dyn Any

Returns a reference to self as Any for downcasting.
Source§

fn as_any_mut(&mut self) -> &mut dyn Any

Returns a mutable reference to self as Any for downcasting.
Source§

fn name(&self) -> &str

Returns the name of this quantity.
Source§

fn structure_name(&self) -> &str

Returns the name of the parent structure.
Source§

fn kind(&self) -> QuantityKind

Returns the kind of this quantity.
Source§

fn is_enabled(&self) -> bool

Returns whether this quantity is currently enabled/visible.
Source§

fn set_enabled(&mut self, enabled: bool)

Sets the enabled state of this quantity.
Source§

fn build_ui(&mut self, _ui: &dyn Any)

Builds the ImGui UI controls for this quantity.
Source§

fn refresh(&mut self)

Refreshes GPU resources after data changes.
Source§

fn data_size(&self) -> usize

Returns the number of data elements.
Source§

fn clear_gpu_resources(&mut self)

Clears GPU render resources so they can be re-initialized with a new device.

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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, 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<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

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
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

Source§

impl<T> WasmNotSync for T
where T: Sync,