GI.Clutter.Structs.PaintVolume

PaintVolume is an opaque structure whose members cannot be directly accessed.

A PaintVolume represents an a bounding volume whose internal representation isn't defined but can be set and queried in terms of an axis aligned bounding box.

A PaintVolume for a Actor is defined to be relative from the current actor modelview matrix.

Other internal representation and methods for describing the bounding volume may be added in the future.

Since: 1.4

Exported types

newtype PaintVolume

Memory-managed wrapper type.

Constructors

PaintVolume (ManagedPtr PaintVolume)

Instances

Eq PaintVolume

Defined in GI.Clutter.Structs.PaintVolume

Methods

(==) :: PaintVolume -> PaintVolume -> Bool

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

GBoxed PaintVolume

Defined in GI.Clutter.Structs.PaintVolume

ManagedPtrNewtype PaintVolume

Defined in GI.Clutter.Structs.PaintVolume

Methods

toManagedPtr :: PaintVolume -> ManagedPtr PaintVolume

TypedObject PaintVolume

Defined in GI.Clutter.Structs.PaintVolume

Methods

glibType :: IO GType

HasParentTypes PaintVolume

Defined in GI.Clutter.Structs.PaintVolume

IsGValue (Maybe PaintVolume)

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

Defined in GI.Clutter.Structs.PaintVolume

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PaintVolume

Defined in GI.Clutter.Structs.PaintVolume

type ParentTypes PaintVolume = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

copy, free, union, unionBox.

Getters

getDepth, getHeight, getOrigin, getWidth.

Setters

setDepth, setFromAllocation, setHeight, setOrigin, setWidth.

copy

paintVolumeCopy

Arguments

:: (HasCallStack, MonadIO m)

=> PaintVolume

pv: a PaintVolume

-> m PaintVolume

Returns: a newly allocated copy of a PaintVolume

Copies pv into a new PaintVolume

Since: 1.6

free

paintVolumeFree

Arguments

:: (HasCallStack, MonadIO m)

=> PaintVolume

pv: a PaintVolume

-> m ()

Frees the resources allocated by pv

Since: 1.6

getDepth

paintVolumeGetDepth

Arguments

:: (HasCallStack, MonadIO m)

=> PaintVolume

pv: a PaintVolume

-> m Float

Returns: the depth, in units of pv's local coordinate system.

Retrieves the depth of the volume's, axis aligned, bounding box.

In other words; this takes into account what actor's coordinate space pv belongs too and conceptually fits an axis aligned box around the volume. It returns the size of that bounding box as measured along the z-axis.

If, for example, actorGetTransformedPaintVolume is used to transform a 2D child actor that is 100px wide, 100px high and 0px deep into container coordinates then the depth might not simply be 0px if the child actor has a 3D rotation applied to it.

Remember: if actorGetTransformedPaintVolume is used then the transformed volume will be defined relative to the container actor and in container coordinates a 2D child actor can have a 3D bounding volume.

There are no accuracy guarantees for the reported depth, except that it must always be greater than, or equal to, the actor's depth. This is because actors may report simple, loose fitting paint volumes for efficiency.

Since: 1.6

getHeight

paintVolumeGetHeight

Arguments

:: (HasCallStack, MonadIO m)

=> PaintVolume

pv: a PaintVolume

-> m Float

Returns: the height, in units of pv's local coordinate system.

Retrieves the height of the volume's, axis aligned, bounding box.

In other words; this takes into account what actor's coordinate space pv belongs too and conceptually fits an axis aligned box around the volume. It returns the size of that bounding box as measured along the y-axis.

If, for example, actorGetTransformedPaintVolume is used to transform a 2D child actor that is 100px wide, 100px high and 0px deep into container coordinates then the height might not simply be 100px if the child actor has a 3D rotation applied to it.

Remember: if actorGetTransformedPaintVolume is used then a transformed child volume will be defined relative to the ancestor container actor and so a 2D child actor can have a 3D bounding volume.

There are no accuracy guarantees for the reported height, except that it must always be greater than, or equal to, the actor's height. This is because actors may report simple, loose fitting paint volumes for efficiency.

Since: 1.6

getOrigin

paintVolumeGetOrigin

Arguments

:: (HasCallStack, MonadIO m)

=> PaintVolume

pv: a PaintVolume

-> m Vertex

Retrieves the origin of the PaintVolume.

Since: 1.6

getWidth

paintVolumeGetWidth

Arguments

:: (HasCallStack, MonadIO m)

=> PaintVolume

pv: a PaintVolume

-> m Float

Returns: the width, in units of pv's local coordinate system.

Retrieves the width of the volume's, axis aligned, bounding box.

In other words; this takes into account what actor's coordinate space pv belongs too and conceptually fits an axis aligned box around the volume. It returns the size of that bounding box as measured along the x-axis.

If, for example, actorGetTransformedPaintVolume is used to transform a 2D child actor that is 100px wide, 100px high and 0px deep into container coordinates then the width might not simply be 100px if the child actor has a 3D rotation applied to it.

Remember: if actorGetTransformedPaintVolume is used then a transformed child volume will be defined relative to the ancestor container actor and so a 2D child actor can have a 3D bounding volume.

There are no accuracy guarantees for the reported width, except that it must always be greater than, or equal to, the actor's width. This is because actors may report simple, loose fitting paint volumes for efficiency.

Since: 1.6

setDepth

paintVolumeSetDepth

Arguments

:: (HasCallStack, MonadIO m)

=> PaintVolume

pv: a PaintVolume

-> Float

depth: the depth of the paint volume, in pixels

-> m ()

Sets the depth of the paint volume. The depth is measured along the z axis in the actor coordinates that pv is associated with.

Since: 1.6

setFromAllocation

paintVolumeSetFromAllocation

Arguments

:: (HasCallStack, MonadIO m, IsActor a)

=> PaintVolume

pv: a PaintVolume

-> a

actor: a Actor

-> m Bool

Returns: True if the paint volume was successfully set, and False otherwise

Sets the PaintVolume from the allocation of actor.

This function should be used when overriding the ActorClass.get_paint_volume() by Actor sub-classes that do not paint outside their allocation.

A typical example is:

static gboolean
my_actor_get_paint_volume (ClutterActor       *self,
                           ClutterPaintVolume *volume)
{
  return clutter_paint_volume_set_from_allocation (volume, self);
}

Since: 1.6

setHeight

paintVolumeSetHeight

Arguments

:: (HasCallStack, MonadIO m)

=> PaintVolume

pv: a PaintVolume

-> Float

height: the height of the paint volume, in pixels

-> m ()

Sets the height of the paint volume. The height is measured along the y axis in the actor coordinates that pv is associated with.

Since: 1.6

setOrigin

paintVolumeSetOrigin

Arguments

:: (HasCallStack, MonadIO m)

=> PaintVolume

pv: a PaintVolume

-> Vertex

origin: a Vertex

-> m ()

Sets the origin of the paint volume.

The origin is defined as the X, Y and Z coordinates of the top-left corner of an actor's paint volume, in actor coordinates.

The default is origin is assumed at: (0, 0, 0)

Since: 1.6

setWidth

paintVolumeSetWidth

Arguments

:: (HasCallStack, MonadIO m)

=> PaintVolume

pv: a PaintVolume

-> Float

width: the width of the paint volume, in pixels

-> m ()

Sets the width of the paint volume. The width is measured along the x axis in the actor coordinates that pv is associated with.

Since: 1.6

union

paintVolumeUnion

Arguments

:: (HasCallStack, MonadIO m)

=> PaintVolume

pv: The first PaintVolume and destination for resulting union

-> PaintVolume

anotherPv: A second PaintVolume to union with pv

-> m ()

Updates the geometry of pv to encompass pv and anotherPv.

There are no guarantees about how precisely the two volumes will be unioned.

Since: 1.6

unionBox

paintVolumeUnionBox

Arguments

:: (HasCallStack, MonadIO m)

=> PaintVolume

pv: a PaintVolume

-> ActorBox

box: a ActorBox to union to pv

-> m ()

Unions the 2D region represented by box to a PaintVolume.

This function is similar to paintVolumeUnion, but it is specific for 2D regions.

Since: 1.10