Struct PathConstraint

pub struct PathConstraint(/* private fields */);

Implementations

impl PathConstraint

pub fn new<P: IsA<Path>>(path: Option<&P>, offset: f32) -> PathConstraint

Creates a new PathConstraint with the given path and offset

path

a Path, or None

offset

the offset along the Path

Returns

the newly created PathConstraint

pub fn get_offset(&self) -> f32

Retrieves the offset along the Path used by self.

Returns

the offset

pub fn get_path(&self) -> Option<Path>

Retrieves a pointer to the Path used by self.

Returns

the Path used by the PathConstraint, or None. The returned Path is owned by the constraint and it should not be unreferenced

pub fn set_offset(&self, offset: f32)

Sets the offset along the Path used by self.

offset

the offset along the path

pub fn set_path<P: IsA<Path>>(&self, path: Option<&P>)

Sets the path to be followed by the PathConstraint.

The self will take ownership of the Path passed to this function.

path

a Path

pub fn connect_node_reached<F: Fn(&PathConstraint, &Actor, u32) + 'static>( &self, f: F, ) -> SignalHandlerId

The ::node-reached signal is emitted each time a PathConstraint:offset value results in the actor passing a PathNode

actor

the Actor using the constraint

index

the index of the node that has been reached

pub fn connect_property_offset_notify<F: Fn(&PathConstraint) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_property_path_notify<F: Fn(&PathConstraint) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for PathConstraint

fn clone(&self) -> PathConstraint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathConstraint

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

Formats the value using the given formatter.

impl Display for PathConstraint

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

Formats the value using the given formatter.

impl Hash for PathConstraint

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 PathConstraint

fn cmp(&self, other: &PathConstraint) -> 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<T: ObjectType> PartialEq<T> for PathConstraint

fn eq(&self, other: &T) -> 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<T: ObjectType> PartialOrd<T> for PathConstraint

fn partial_cmp(&self, other: &T) -> 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 PathConstraint

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for PathConstraint

impl IsA<ActorMeta> for PathConstraint

impl IsA<Constraint> for PathConstraint

impl IsA<InitiallyUnowned> for PathConstraint