gi-clutter-1.0.2: clutter GObject bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Clutter.Objects.BehaviourPath

Description

The BehaviourPath structure contains only private data and should be accessed using the provided API

Since: 0.2

Synopsis

Exported types

class (GObject o, IsDescendantOf BehaviourPath o) => IsBehaviourPath o Source #

Type class for types which can be safely cast to BehaviourPath, for instance with toBehaviourPath.

Instances

Instances details
(GObject o, IsDescendantOf BehaviourPath o) => IsBehaviourPath o Source # 
Instance details

Defined in GI.Clutter.Objects.BehaviourPath

toBehaviourPath :: (MonadIO m, IsBehaviourPath o) => o -> m BehaviourPath Source #

Cast to BehaviourPath, for types for which this is known to be safe. For general casts, use castTo.

Methods

getPath

behaviourPathGetPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsBehaviourPath a) 
=> a

pathb: a BehaviourPath instance

-> m Path

Returns: the path

Deprecated: (Since version 1.6)

Get the current path of the behaviour

Since: 1.0

new

behaviourPathNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsAlpha a, IsPath b) 
=> Maybe a

alpha: a Alpha instance, or Nothing

-> b

path: a Path or Nothing for an empty path

-> m BehaviourPath

Returns: a Behaviour

Deprecated: (Since version 1.6)

Creates a new path behaviour. You can use this behaviour to drive actors along the nodes of a path, described by path.

This will claim the floating reference on the Path so you do not need to unref if it.

If alpha is not Nothing, the Behaviour will take ownership of the Alpha instance. In the case when alpha is Nothing, it can be set later with behaviourSetAlpha.

Since: 0.2

newWithDescription

behaviourPathNewWithDescription Source #

Arguments

:: (HasCallStack, MonadIO m, IsAlpha a) 
=> Maybe a

alpha: a Alpha instance, or Nothing

-> Text

desc: a string description of the path

-> m BehaviourPath

Returns: a Behaviour

Deprecated: (Since version 1.6)

Creates a new path behaviour using the path described by desc. See pathAddString for a description of the format.

If alpha is not Nothing, the Behaviour will take ownership of the Alpha instance. In the case when alpha is Nothing, it can be set later with behaviourSetAlpha.

Since: 1.0

newWithKnots

behaviourPathNewWithKnots Source #

Arguments

:: (HasCallStack, MonadIO m, IsAlpha a) 
=> Maybe a

alpha: a Alpha instance, or Nothing

-> [Knot]

knots: an array of Knots

-> m BehaviourPath

Returns: a Behaviour

Deprecated: (Since version 1.6)

Creates a new path behaviour that will make the actors visit all of the given knots in order with straight lines in between.

A path will be created where the first knot is used in a PathNodeTypeMoveTo and the subsequent knots are used in PathNodeTypeLineTos.

If alpha is not Nothing, the Behaviour will take ownership of the Alpha instance. In the case when alpha is Nothing, it can be set later with behaviourSetAlpha.

Since: 1.0

setPath

behaviourPathSetPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsBehaviourPath a, IsPath b) 
=> a

pathb: the path behaviour

-> b

path: the new path to follow

-> m () 

Deprecated: (Since version 1.6)

Change the path that the actors will follow. This will take the floating reference on the Path so you do not need to unref it.

Since: 1.0

Properties

path

No description available in the introspection data.

constructBehaviourPathPath :: (IsBehaviourPath o, MonadIO m, IsPath a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “path” property. This is rarely needed directly, but it is used by new.

getBehaviourPathPath :: (MonadIO m, IsBehaviourPath o) => o -> m Path Source #

Get the value of the “path” property. When overloading is enabled, this is equivalent to

get behaviourPath #path

setBehaviourPathPath :: (MonadIO m, IsBehaviourPath o, IsPath a) => o -> a -> m () Source #

Set the value of the “path” property. When overloading is enabled, this is equivalent to

set behaviourPath [ #path := value ]

Signals

knotReached

type BehaviourPathKnotReachedCallback Source #

Arguments

 = Word32

knotNum: the index of the Knot reached

-> IO () 

Deprecated: (Since version 1.6)

This signal is emitted each time a node defined inside the path is reached.

Since: 0.2

afterBehaviourPathKnotReached :: (IsBehaviourPath a, MonadIO m) => a -> ((?self :: a) => BehaviourPathKnotReachedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the knotReached signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after behaviourPath #knotReached callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onBehaviourPathKnotReached :: (IsBehaviourPath a, MonadIO m) => a -> ((?self :: a) => BehaviourPathKnotReachedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the knotReached signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on behaviourPath #knotReached callback