gi-clutter-1.0.6: 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.BehaviourEllipse

Description

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

Since: 0.4

Synopsis

Exported types

newtype BehaviourEllipse Source #

Memory-managed wrapper type.

Constructors

BehaviourEllipse (ManagedPtr BehaviourEllipse) 

Instances

Instances details
Eq BehaviourEllipse Source # 
Instance details

Defined in GI.Clutter.Objects.BehaviourEllipse

GObject BehaviourEllipse Source # 
Instance details

Defined in GI.Clutter.Objects.BehaviourEllipse

ManagedPtrNewtype BehaviourEllipse Source # 
Instance details

Defined in GI.Clutter.Objects.BehaviourEllipse

TypedObject BehaviourEllipse Source # 
Instance details

Defined in GI.Clutter.Objects.BehaviourEllipse

Methods

glibType :: IO GType

HasParentTypes BehaviourEllipse Source # 
Instance details

Defined in GI.Clutter.Objects.BehaviourEllipse

IsGValue (Maybe BehaviourEllipse) Source #

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

Instance details

Defined in GI.Clutter.Objects.BehaviourEllipse

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes BehaviourEllipse Source # 
Instance details

Defined in GI.Clutter.Objects.BehaviourEllipse

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

class (GObject o, IsDescendantOf BehaviourEllipse o) => IsBehaviourEllipse o Source #

Type class for types which can be safely cast to BehaviourEllipse, for instance with toBehaviourEllipse.

Instances

Instances details
(GObject o, IsDescendantOf BehaviourEllipse o) => IsBehaviourEllipse o Source # 
Instance details

Defined in GI.Clutter.Objects.BehaviourEllipse

toBehaviourEllipse :: (MonadIO m, IsBehaviourEllipse o) => o -> m BehaviourEllipse Source #

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

Methods

getAngleEnd

behaviourEllipseGetAngleEnd Source #

Arguments

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

self: a BehaviourEllipse

-> m Double

Returns: angle in degrees

Gets the at which movements ends.

Since: 0.4

getAngleStart

behaviourEllipseGetAngleStart Source #

Arguments

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

self: a BehaviourEllipse

-> m Double

Returns: angle in degrees

Gets the angle at which movements starts.

Since: 0.6

getAngleTilt

behaviourEllipseGetAngleTilt Source #

Arguments

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

self: a BehaviourEllipse

-> RotateAxis

axis: a RotateAxis

-> m Double

Returns: angle in degrees.

Gets the tilt of the ellipse around the center in the given axis.

Since: 0.4

getCenter

behaviourEllipseGetCenter Source #

Arguments

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

self: a BehaviourEllipse

-> m (Int32, Int32) 

Gets the center of the elliptical path path.

Since: 0.4

getDirection

behaviourEllipseGetDirection Source #

Arguments

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

self: a BehaviourEllipse

-> m RotateDirection

Returns: the rotation direction

Retrieves the RotateDirection used by the ellipse behaviour.

Since: 0.4

getHeight

behaviourEllipseGetHeight Source #

Arguments

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

self: a BehaviourEllipse

-> m Int32

Returns: the height of the path

Gets the height of the elliptical path.

Since: 0.4

getTilt

behaviourEllipseGetTilt Source #

Arguments

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

self: a BehaviourEllipse

-> m (Double, Double, Double) 

Gets the tilt of the ellipse around the center in Y axis.

Since: 0.4

getWidth

behaviourEllipseGetWidth Source #

Arguments

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

self: a BehaviourEllipse

-> m Int32

Returns: the width of the path

Gets the width of the elliptical path.

Since: 0.4

new

behaviourEllipseNew Source #

Arguments

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

alpha: a Alpha instance, or Nothing

-> Int32

x: x coordinace of the center

-> Int32

y: y coordiance of the center

-> Int32

width: width of the ellipse

-> Int32

height: height of the ellipse

-> RotateDirection

direction: RotateDirection of rotation

-> Double

start: angle in degrees at which movement starts, between 0 and 360

-> Double

end: angle in degrees at which movement ends, between 0 and 360

-> m BehaviourEllipse

Returns: the newly created BehaviourEllipse

Creates a behaviour that drives actors along an elliptical path with given center, width and height; the movement starts at start degrees (with 0 corresponding to 12 o'clock) and ends at end degrees. Angles greated than 360 degrees get clamped to the canonical interval <0, 360); if start is equal to end, the behaviour will rotate by exacly 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

setAngleEnd

behaviourEllipseSetAngleEnd Source #

Arguments

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

self: a BehaviourEllipse

-> Double

angleEnd: angle at which movement ends in degrees, between 0 and 360.

-> m () 

Sets the angle at which movement ends; angles >= 360 degress get clamped to the canonical interval <0, 360).

Since: 0.4

setAngleStart

behaviourEllipseSetAngleStart Source #

Arguments

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

self: a BehaviourEllipse

-> Double

angleStart: angle at which movement starts in degrees, between 0 and 360.

-> m () 

Sets the angle at which movement starts; angles >= 360 degress get clamped to the canonical interval <0, 360).

Since: 0.6

setAngleTilt

behaviourEllipseSetAngleTilt Source #

Arguments

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

self: a BehaviourEllipse

-> RotateAxis

axis: a RotateAxis

-> Double

angleTilt: tilt of the elipse around the center in the given axis in degrees.

-> m () 

Sets the angle at which the ellipse should be tilted around it's center.

Since: 0.4

setCenter

behaviourEllipseSetCenter Source #

Arguments

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

self: a BehaviourEllipse

-> Int32

x: x coordinace of centre

-> Int32

y: y coordinace of centre

-> m () 

Sets the center of the elliptical path to the point represented by knot.

Since: 0.4

setDirection

behaviourEllipseSetDirection Source #

Arguments

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

self: a BehaviourEllipse

-> RotateDirection

direction: the rotation direction

-> m () 

Sets the rotation direction used by the ellipse behaviour.

Since: 0.4

setHeight

behaviourEllipseSetHeight Source #

Arguments

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

self: a BehaviourEllipse

-> Int32

height: height of the ellipse

-> m () 

Sets the height of the elliptical path.

Since: 0.4

setTilt

behaviourEllipseSetTilt Source #

Arguments

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

self: a BehaviourEllipse

-> Double

angleTiltX: tilt of the elipse around the center in X axis in degrees.

-> Double

angleTiltY: tilt of the elipse around the center in Y axis in degrees.

-> Double

angleTiltZ: tilt of the elipse around the center in Z axis in degrees.

-> m () 

Sets the angles at which the ellipse should be tilted around it's center.

Since: 0.4

setWidth

behaviourEllipseSetWidth Source #

Arguments

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

self: a BehaviourEllipse

-> Int32

width: width of the ellipse

-> m () 

Sets the width of the elliptical path.

Since: 0.4

Properties

angleEnd

The final angle to where the rotation should end.

Since: 0.4

constructBehaviourEllipseAngleEnd :: (IsBehaviourEllipse o, MonadIO m) => Double -> m (GValueConstruct o) Source #

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

getBehaviourEllipseAngleEnd :: (MonadIO m, IsBehaviourEllipse o) => o -> m Double Source #

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

get behaviourEllipse #angleEnd

setBehaviourEllipseAngleEnd :: (MonadIO m, IsBehaviourEllipse o) => o -> Double -> m () Source #

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

set behaviourEllipse [ #angleEnd := value ]

angleStart

The initial angle from where the rotation should start.

Since: 0.4

constructBehaviourEllipseAngleStart :: (IsBehaviourEllipse o, MonadIO m) => Double -> m (GValueConstruct o) Source #

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

getBehaviourEllipseAngleStart :: (MonadIO m, IsBehaviourEllipse o) => o -> m Double Source #

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

get behaviourEllipse #angleStart

setBehaviourEllipseAngleStart :: (MonadIO m, IsBehaviourEllipse o) => o -> Double -> m () Source #

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

set behaviourEllipse [ #angleStart := value ]

angleTiltX

The tilt angle for the rotation around center in X axis

Since: 0.4

constructBehaviourEllipseAngleTiltX :: (IsBehaviourEllipse o, MonadIO m) => Double -> m (GValueConstruct o) Source #

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

getBehaviourEllipseAngleTiltX :: (MonadIO m, IsBehaviourEllipse o) => o -> m Double Source #

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

get behaviourEllipse #angleTiltX

setBehaviourEllipseAngleTiltX :: (MonadIO m, IsBehaviourEllipse o) => o -> Double -> m () Source #

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

set behaviourEllipse [ #angleTiltX := value ]

angleTiltY

The tilt angle for the rotation around center in Y axis

Since: 0.4

constructBehaviourEllipseAngleTiltY :: (IsBehaviourEllipse o, MonadIO m) => Double -> m (GValueConstruct o) Source #

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

getBehaviourEllipseAngleTiltY :: (MonadIO m, IsBehaviourEllipse o) => o -> m Double Source #

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

get behaviourEllipse #angleTiltY

setBehaviourEllipseAngleTiltY :: (MonadIO m, IsBehaviourEllipse o) => o -> Double -> m () Source #

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

set behaviourEllipse [ #angleTiltY := value ]

angleTiltZ

The tilt angle for the rotation on the Z axis

Since: 0.4

constructBehaviourEllipseAngleTiltZ :: (IsBehaviourEllipse o, MonadIO m) => Double -> m (GValueConstruct o) Source #

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

getBehaviourEllipseAngleTiltZ :: (MonadIO m, IsBehaviourEllipse o) => o -> m Double Source #

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

get behaviourEllipse #angleTiltZ

setBehaviourEllipseAngleTiltZ :: (MonadIO m, IsBehaviourEllipse o) => o -> Double -> m () Source #

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

set behaviourEllipse [ #angleTiltZ := value ]

center

The center of the ellipse.

Since: 0.4

clearBehaviourEllipseCenter :: (MonadIO m, IsBehaviourEllipse o) => o -> m () Source #

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

clear #center

constructBehaviourEllipseCenter :: (IsBehaviourEllipse o, MonadIO m) => Knot -> m (GValueConstruct o) Source #

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

getBehaviourEllipseCenter :: (MonadIO m, IsBehaviourEllipse o) => o -> m (Maybe Knot) Source #

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

get behaviourEllipse #center

setBehaviourEllipseCenter :: (MonadIO m, IsBehaviourEllipse o) => o -> Knot -> m () Source #

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

set behaviourEllipse [ #center := value ]

direction

The direction of the rotation.

Since: 0.4

constructBehaviourEllipseDirection :: (IsBehaviourEllipse o, MonadIO m) => RotateDirection -> m (GValueConstruct o) Source #

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

getBehaviourEllipseDirection :: (MonadIO m, IsBehaviourEllipse o) => o -> m RotateDirection Source #

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

get behaviourEllipse #direction

setBehaviourEllipseDirection :: (MonadIO m, IsBehaviourEllipse o) => o -> RotateDirection -> m () Source #

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

set behaviourEllipse [ #direction := value ]

height

Height of the ellipse, in pixels

Since: 0.4

constructBehaviourEllipseHeight :: (IsBehaviourEllipse o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getBehaviourEllipseHeight :: (MonadIO m, IsBehaviourEllipse o) => o -> m Int32 Source #

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

get behaviourEllipse #height

setBehaviourEllipseHeight :: (MonadIO m, IsBehaviourEllipse o) => o -> Int32 -> m () Source #

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

set behaviourEllipse [ #height := value ]

width

Width of the ellipse, in pixels

Since: 0.4

constructBehaviourEllipseWidth :: (IsBehaviourEllipse o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getBehaviourEllipseWidth :: (MonadIO m, IsBehaviourEllipse o) => o -> m Int32 Source #

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

get behaviourEllipse #width

setBehaviourEllipseWidth :: (MonadIO m, IsBehaviourEllipse o) => o -> Int32 -> m () Source #

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

set behaviourEllipse [ #width := value ]