GI.Clutter.Objects.BehaviourRotate

The BehaviourRotate struct contains only private data and should be accessed using the provided API

Since: 0.4

Exported types

newtype BehaviourRotate

Memory-managed wrapper type.

Constructors

BehaviourRotate (ManagedPtr BehaviourRotate)

Instances

Eq BehaviourRotate

Defined in GI.Clutter.Objects.BehaviourRotate

Methods

(==) :: BehaviourRotate -> BehaviourRotate -> Bool

(/=) :: BehaviourRotate -> BehaviourRotate -> Bool

GObject BehaviourRotate

Defined in GI.Clutter.Objects.BehaviourRotate

ManagedPtrNewtype BehaviourRotate

Defined in GI.Clutter.Objects.BehaviourRotate

Methods

toManagedPtr :: BehaviourRotate -> ManagedPtr BehaviourRotate

TypedObject BehaviourRotate

Defined in GI.Clutter.Objects.BehaviourRotate

Methods

glibType :: IO GType

HasParentTypes BehaviourRotate

Defined in GI.Clutter.Objects.BehaviourRotate

IsGValue (Maybe BehaviourRotate)

Convert BehaviourRotate to and from GValue. See toGValue and fromGValue.

Defined in GI.Clutter.Objects.BehaviourRotate

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe BehaviourRotate -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe BehaviourRotate)

type ParentTypes BehaviourRotate

Defined in GI.Clutter.Objects.BehaviourRotate

type ParentTypes BehaviourRotate = '[Behaviour, Object, Scriptable]

class (GObject o, IsDescendantOf BehaviourRotate o) => IsBehaviourRotate o

Type class for types which can be safely cast to BehaviourRotate, for instance with toBehaviourRotate.

Instances

(GObject o, IsDescendantOf BehaviourRotate o) => IsBehaviourRotate o

Defined in GI.Clutter.Objects.BehaviourRotate

toBehaviourRotate :: (MonadIO m, IsBehaviourRotate o) => o -> m BehaviourRotate

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

Methods

Click to display all available methods, including inherited ones

Methods

actorsForeach, apply, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isApplied, isFloating, notify, notifyByPspec, parseCustomNode, ref, refSink, remove, removeAll, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getActors, getAlpha, getAxis, getBounds, getCenter, getData, getDirection, getId, getNActors, getNthActor, getProperty, getQdata.

Setters

setAlpha, setAxis, setBounds, setCenter, setCustomProperty, setData, setDataFull, setDirection, setId, setProperty.

getAxis

behaviourRotateGetAxis

Arguments

:: (HasCallStack, MonadIO m, IsBehaviourRotate a)

=> a

rotate: a BehaviourRotate

-> m RotateAxis

Returns: the rotation axis

Retrieves the RotateAxis used by the rotate behaviour.

Since: 0.4

getBounds

behaviourRotateGetBounds

Arguments

:: (HasCallStack, MonadIO m, IsBehaviourRotate a)

=> a

rotate: a BehaviourRotate

-> m (Double, Double)

Retrieves the rotation boundaries of the rotate behaviour.

Since: 0.4

getCenter

behaviourRotateGetCenter

Arguments

:: (HasCallStack, MonadIO m, IsBehaviourRotate a)

=> a

rotate: a BehaviourRotate

-> m (Int32, Int32, Int32)

Retrieves the center of rotation set using behaviourRotateSetCenter.

Since: 0.4

getDirection

behaviourRotateGetDirection

Arguments

:: (HasCallStack, MonadIO m, IsBehaviourRotate a)

=> a

rotate: a BehaviourRotate

-> m RotateDirection

Returns: the rotation direction

Retrieves the RotateDirection used by the rotate behaviour.

Since: 0.4

new

behaviourRotateNew

Arguments

:: (HasCallStack, MonadIO m, IsAlpha a)

=> Maybe a

alpha: a Alpha instance, or Nothing

-> RotateAxis

axis: the rotation axis

-> RotateDirection

direction: the rotation direction

-> Double

angleStart: the starting angle in degrees, between 0 and 360.

-> Double

angleEnd: the final angle in degrees, between 0 and 360.

-> m BehaviourRotate

Returns: the newly created BehaviourRotate.

Creates a new BehaviourRotate. This behaviour will rotate actors bound to it on axis, following direction, between angleStart and angleEnd. Angles >= 360 degrees will be clamped to the canonical interval <0, 360), if angle_start == angle_end, the behaviour will carry out a single rotation of 360 degrees.

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.4

setAxis

behaviourRotateSetAxis

Arguments

:: (HasCallStack, MonadIO m, IsBehaviourRotate a)

=> a

rotate: a BehaviourRotate

-> RotateAxis

axis: a RotateAxis

-> m ()

Sets the axis used by the rotate behaviour.

Since: 0.4

setBounds

behaviourRotateSetBounds

Arguments

:: (HasCallStack, MonadIO m, IsBehaviourRotate a)

=> a

rotate: a BehaviourRotate

-> Double

angleStart: initial angle in degrees, between 0 and 360.

-> Double

angleEnd: final angle in degrees, between 0 and 360.

-> m ()

Sets the initial and final angles of a rotation behaviour; angles >= 360 degrees get clamped to the canonical interval <0, 360).

Since: 0.4

setCenter

behaviourRotateSetCenter

Arguments

:: (HasCallStack, MonadIO m, IsBehaviourRotate a)

=> a

rotate: a BehaviourRotate

-> Int32

x: X axis center of rotation

-> Int32

y: Y axis center of rotation

-> Int32

z: Z axis center of rotation

-> m ()

Sets the center of rotation. The coordinates are relative to the plane normal to the rotation axis set with behaviourRotateSetAxis.

Since: 0.4

setDirection

behaviourRotateSetDirection

Arguments

:: (HasCallStack, MonadIO m, IsBehaviourRotate a)

=> a

rotate: a BehaviourRotate

-> RotateDirection

direction: the rotation direction

-> m ()

Sets the rotation direction used by the rotate behaviour.

Since: 0.4

Properties

angleEnd

The final angle to where the rotation should end.

Since: 0.4

constructBehaviourRotateAngleEnd :: (IsBehaviourRotate o, MonadIO m) => Double -> m (GValueConstruct o)

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

getBehaviourRotateAngleEnd :: (MonadIO m, IsBehaviourRotate o) => o -> m Double

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

get behaviourRotate #angleEnd

setBehaviourRotateAngleEnd :: (MonadIO m, IsBehaviourRotate o) => o -> Double -> m ()

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

set behaviourRotate [ #angleEnd := value ]

angleStart

The initial angle from whence the rotation should start.

Since: 0.4

constructBehaviourRotateAngleStart :: (IsBehaviourRotate o, MonadIO m) => Double -> m (GValueConstruct o)

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

getBehaviourRotateAngleStart :: (MonadIO m, IsBehaviourRotate o) => o -> m Double

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

get behaviourRotate #angleStart

setBehaviourRotateAngleStart :: (MonadIO m, IsBehaviourRotate o) => o -> Double -> m ()

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

set behaviourRotate [ #angleStart := value ]

axis

The axis of rotation.

Since: 0.4

constructBehaviourRotateAxis :: (IsBehaviourRotate o, MonadIO m) => RotateAxis -> m (GValueConstruct o)

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

getBehaviourRotateAxis :: (MonadIO m, IsBehaviourRotate o) => o -> m RotateAxis

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

get behaviourRotate #axis

setBehaviourRotateAxis :: (MonadIO m, IsBehaviourRotate o) => o -> RotateAxis -> m ()

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

set behaviourRotate [ #axis := value ]

centerX

The x center of rotation.

Since: 0.4

constructBehaviourRotateCenterX :: (IsBehaviourRotate o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getBehaviourRotateCenterX :: (MonadIO m, IsBehaviourRotate o) => o -> m Int32

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

get behaviourRotate #centerX

setBehaviourRotateCenterX :: (MonadIO m, IsBehaviourRotate o) => o -> Int32 -> m ()

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

set behaviourRotate [ #centerX := value ]

centerY

The y center of rotation.

Since: 0.4

constructBehaviourRotateCenterY :: (IsBehaviourRotate o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getBehaviourRotateCenterY :: (MonadIO m, IsBehaviourRotate o) => o -> m Int32

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

get behaviourRotate #centerY

setBehaviourRotateCenterY :: (MonadIO m, IsBehaviourRotate o) => o -> Int32 -> m ()

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

set behaviourRotate [ #centerY := value ]

centerZ

The z center of rotation.

Since: 0.4

constructBehaviourRotateCenterZ :: (IsBehaviourRotate o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getBehaviourRotateCenterZ :: (MonadIO m, IsBehaviourRotate o) => o -> m Int32

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

get behaviourRotate #centerZ

setBehaviourRotateCenterZ :: (MonadIO m, IsBehaviourRotate o) => o -> Int32 -> m ()

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

set behaviourRotate [ #centerZ := value ]

direction

The direction of the rotation.

Since: 0.4

constructBehaviourRotateDirection :: (IsBehaviourRotate o, MonadIO m) => RotateDirection -> m (GValueConstruct o)

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

getBehaviourRotateDirection :: (MonadIO m, IsBehaviourRotate o) => o -> m RotateDirection

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

get behaviourRotate #direction

setBehaviourRotateDirection :: (MonadIO m, IsBehaviourRotate o) => o -> RotateDirection -> m ()

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

set behaviourRotate [ #direction := value ]