Struct gegl::Path

#[repr(transparent)]
pub struct Path { /* private fields */ }

Signals

changed

GLib type: GObject with reference counted clone semantics.

Implementations

impl Path

pub fn new() -> Path

Creates a new Path with no nodes.

Returns the newly created Path

pub fn from_string(instructions: &str) -> Path

Creates a new Path with the nodes described in the string instructions. See parse_string() for details of the format of the string.

Returns the newly created Path

instructions

a string describing the path.

pub fn calc(&self, pos: f64) -> Option<(f64, f64)>

Compute the coordinates of the path at the position (length measured from start of path, not including discontinuities).

pos

how far along the path.

Returns

x

return location for x coordinate.

y

return location for y coordinate

pub fn calc_y_for_x(&self, x: f64) -> (i32, f64)

Compute a corresponding y coordinate for a given x input coordinate, returns 0 if computed correctly and -1 if the path doesn’t exist for the specified x coordinate.

x

x coordinate to compute for

Returns

y

return location for y coordinate

pub fn clear(&self)

Remove all nods from a self.

pub fn closest_point(&self, x: f64, y: f64) -> (f64, f64, f64, i32)

Figure out what and where on a path is closest to arbitrary coordinates.

Returns the length along the path where the closest point was encountered.

x

x coordinate.

y

y coordinate

Returns

on_path_x

return location for x coordinate on the path that was closest

on_path_y

return location for y coordinate on the path that was closest

node_pos_before

the node position interpreted before this position was deemed the closest coordinate.

pub fn dirty(&self)

Marks the path as dirty and issues an invalidation for the path rendering, use this if modifying the values of a GeglPathPoint inline.

pub fn freeze(&self)

Make the Path stop firing signals as it changes must be paired with a thaw() for the signals to start again.

pub fn bounds(&self) -> (f64, f64, f64, f64)

Compute the bounding box of a path.

Returns

min_x

return location for minimum x coordinate

max_x

return location for maximum x coordinate

min_y

return location for minimum y coordinate

max_y

return location for maximum y coordinate

pub fn length(&self) -> f64

Returns the total length of the path.

Returns

the length of the path.

pub fn n_nodes(&self) -> i32

Retrieves the number of nodes in the path.

Returns

the number of nodes in the path.

pub fn is_empty(&self) -> bool

Check if the path contains any nodes.

Returns TRUE if the path has no nodes.

pub fn parse_string(&self, instructions: &str)

Parses instructions and appends corresponding nodes to path (call gegl_path_clean() first if you want to replace the existing path.

instructions

a string describing a path.

pub fn remove_node(&self, pos: i32)

Removes the node number pos in self.

pos

a node in the path.

pub fn set_matrix(&self, matrix: &mut Matrix3)

Set the transformation matrix of the path.

The path is transformed through this matrix when being evaluated, causing the calculated positions and length to be changed by the transform.

matrix

a Matrix3 to copy the matrix from

pub fn thaw(&self)

Restart firing signals (unless the path has been frozen multiple times).

pub fn to_str(&self) -> GString

Serialize the paths nodes to a string.

Returns

return a string with instructions describing the string you need to free this with g_free().

pub fn add_type(type_: Char, items: i32, description: &str)

Adds a new type to the path system, FIXME this should probably return something on registration conflicts, for now it expects all registered paths to be aware of each other.

type_

a gchar to recognize in path descriptions.

items

the number of floating point data items the instruction takes

description

a human readable description of this entry

Trait Implementations

impl Clone for Path

fn clone(&self) -> Self

Makes a clone of this shared reference.

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

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Default for Path

fn default() -> Self

Returns the “default value” for a type.

impl Display for Path

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

Formats the value using the given formatter.

impl HasParamSpec for Path

type ParamSpec = ParamSpecObject

type SetValue = Path

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

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Path>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Path

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

Hashes the memory address of this object.

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 Path

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Path

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Path

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

impl<OT: ObjectType> PartialOrd<OT> for Path

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for Path

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Path