Skip to main content

ScalarField

Enum ScalarField 

Source
pub enum ScalarField {
Show 13 variants Const(f32), CoordX, CoordY, Time, Gaussian { center: Box<VectorField>, sigma: f32, }, Disk { center: Box<VectorField>, radius: f32, falloff: Falloff, }, Linear { normal: Box<VectorField>, offset: f32, }, Add(Box<ScalarField>, Box<ScalarField>), Mul(Box<ScalarField>, Box<ScalarField>), Scale(Box<ScalarField>, f32), Negate(Box<ScalarField>), Dot(Box<VectorField>, Box<VectorField>), Sample(FieldId),
}
Expand description

A scalar field expression. Recursive cases use Box to keep the enum sized.

Variants§

§

Const(f32)

Constant value everywhere.

§

CoordX

The x-coordinate at the evaluation point.

§

CoordY

The y-coordinate at the evaluation point.

§

Time

The current time (seconds since a host-chosen epoch).

§

Gaussian

exp(-||p - center||^2 / (2 sigma^2)).

Fields

§sigma: f32
§

Disk

1.0 at center, 0.0 outside radius, with a falloff inside.

Fields

§radius: f32
§falloff: Falloff
§

Linear

dot(normal(p), p) + offset.

Fields

§offset: f32
§

Add(Box<ScalarField>, Box<ScalarField>)

Pointwise sum.

§

Mul(Box<ScalarField>, Box<ScalarField>)

Pointwise product.

§

Scale(Box<ScalarField>, f32)

Pointwise multiply by a constant scalar.

§

Negate(Box<ScalarField>)

Negation.

§

Dot(Box<VectorField>, Box<VectorField>)

Dot product of two vector fields.

§

Sample(FieldId)

Reference to another registered scalar field by id.

Implementations§

Source§

impl ScalarField

Source

pub fn gaussian_at(cx: f32, cy: f32, sigma: f32) -> ScalarField

Gaussian centered at a constant point.

Source

pub fn disk_at(cx: f32, cy: f32, radius: f32, falloff: Falloff) -> ScalarField

Disk centered at a constant point.

Source

pub fn linear(nx: f32, ny: f32, offset: f32) -> ScalarField

Linear with a constant normal: dot((nx, ny), p) + offset.

Trait Implementations§

Source§

impl Clone for ScalarField

Source§

fn clone(&self) -> ScalarField

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ScalarField

Source§

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

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

impl<'de> Deserialize<'de> for ScalarField

Source§

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

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

impl PartialEq for ScalarField

Source§

fn eq(&self, other: &ScalarField) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for ScalarField

Source§

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

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

impl StructuralPartialEq for ScalarField

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T> MemoryPayload for T
where T: Clone + Debug + Serialize + for<'de> Deserialize<'de>,

Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.