Struct ux::PathConstraint

pub struct PathConstraint(_, _);

Implementations

impl PathConstraint[−]

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

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>(&self, path: Option<&P>) where
    P: IsA<Path>, [−]

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>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&PathConstraint, &Actor, u32), [−]

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>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&PathConstraint), 

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

Trait Implementations

impl Clone for PathConstraint[+]

[+] Show hidden undocumented items

pub fn clone(&self) -> PathConstraint[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for PathConstraint[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Display for PathConstraint[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for PathConstraint

impl Hash for PathConstraint[+]

[+] Show hidden undocumented items

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, [−]

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl IsA<ActorMeta> for PathConstraint

impl IsA<Constraint> for PathConstraint

impl IsA<InitiallyUnowned> for PathConstraint

impl Ord for PathConstraint[+]

[+] Show hidden undocumented items

pub fn cmp(&self, other: &PathConstraint) -> Ordering[−]

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl<T> PartialEq<T> for PathConstraint where
    T: ObjectType, [+]

[+] Show hidden undocumented items

pub fn eq(&self, other: &T) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

pub fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl<T> PartialOrd<T> for PathConstraint where
    T: ObjectType, [+]

[+] Show hidden undocumented items

pub fn partial_cmp(&self, other: &T) -> Option<Ordering>[−]

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

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn le(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub 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 PathConstraint[+]

[+] Show hidden undocumented items

pub fn static_type() -> Type[−]

Returns the type identifier of Self.