Struct PathMeasure

pub struct PathMeasure { /* private fields */ }

Available on crate feature v4_14 only.

An object that allows measurements on paths such as determining the length of the path.

Many measuring operations require sampling the path length at intermediate points. Therefore, a PathMeasure has a tolerance that determines what precision is required for such approximations.

A PathMeasure struct is a reference counted struct and should be treated as opaque.

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl PathMeasure

pub fn as_ptr(&self) -> *mut GskPathMeasure

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GskPathMeasure) -> &Self

Borrows the underlying C value.

impl PathMeasure

pub fn new(path: &Path) -> PathMeasure

Creates a measure object for the given @path with the default tolerance.

path

the path to measure

Returns

a new PathMeasure representing @path

pub fn with_tolerance(path: &Path, tolerance: f32) -> PathMeasure

Creates a measure object for the given @path and @tolerance.

path

the path to measure

tolerance

the tolerance for measuring operations

Returns

a new PathMeasure representing @path

pub fn length(&self) -> f32

Gets the length of the path being measured.

The length is cached, so this function does not do any work.

Returns

the length of the path measured by @self

pub fn path(&self) -> Path

Returns the path that the measure was created for.

Returns

the path of @self

pub fn point(&self, distance: f32) -> Option<PathPoint>

Gets the point at the given distance into the path.

An empty path has no points, so false is returned in that case.

distance

the distance

Returns

true if @result was set

result

return location for the point

pub fn tolerance(&self) -> f32

Returns the tolerance that the measure was created with.

Returns

the tolerance of @self

Trait Implementations

impl Clone for PathMeasure

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the reference. Dropping the reference will decrement it again.

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

Performs copy-assignment from source.

impl Debug for PathMeasure

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

Formats the value using the given formatter.

impl From<PathMeasure> for Value

fn from(s: PathMeasure) -> Self

Converts to this type from the input type.

impl HasParamSpec for PathMeasure

type ParamSpec = ParamSpecBoxed

type SetValue = PathMeasure

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, PathMeasure>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for PathMeasure

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PathMeasure

fn cmp(&self, other: &PathMeasure) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PathMeasure

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PathMeasure

fn partial_cmp(&self, other: &PathMeasure) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for PathMeasure

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PathMeasure

impl StructuralPartialEq for PathMeasure