Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
GskTransform
is an object to describe transform matrices.
Unlike graphene_matrix_t
, GskTransform
retains the steps in how
a transform was constructed, and allows inspecting them. It is modeled
after the way CSS describes transforms.
GskTransform
objects are immutable and cannot be changed after creation.
This means code can safely expose them as properties of objects without
having to worry about others changing them.
Synopsis
- newtype Transform = Transform (ManagedPtr Transform)
- transformEqual :: (HasCallStack, MonadIO m) => Transform -> Maybe Transform -> m Bool
- transformGetCategory :: (HasCallStack, MonadIO m) => Transform -> m TransformCategory
- transformInvert :: (HasCallStack, MonadIO m) => Transform -> m (Maybe Transform)
- transformMatrix :: (HasCallStack, MonadIO m) => Transform -> Matrix -> m Transform
- transformNew :: (HasCallStack, MonadIO m) => m Transform
- transformParse :: (HasCallStack, MonadIO m) => Text -> m (Bool, Transform)
- transformPerspective :: (HasCallStack, MonadIO m) => Transform -> Float -> m Transform
- transformPrint :: (HasCallStack, MonadIO m) => Transform -> String -> m ()
- transformRef :: (HasCallStack, MonadIO m) => Transform -> m (Maybe Transform)
- transformRotate :: (HasCallStack, MonadIO m) => Transform -> Float -> m (Maybe Transform)
- transformRotate3d :: (HasCallStack, MonadIO m) => Transform -> Float -> Vec3 -> m (Maybe Transform)
- transformScale :: (HasCallStack, MonadIO m) => Transform -> Float -> Float -> m (Maybe Transform)
- transformScale3d :: (HasCallStack, MonadIO m) => Transform -> Float -> Float -> Float -> m (Maybe Transform)
- transformSkew :: (HasCallStack, MonadIO m) => Transform -> Float -> Float -> m (Maybe Transform)
- transformTo2d :: (HasCallStack, MonadIO m) => Transform -> m (Float, Float, Float, Float, Float, Float)
- transformTo2dComponents :: (HasCallStack, MonadIO m) => Transform -> m (Float, Float, Float, Float, Float, Float, Float)
- transformToAffine :: (HasCallStack, MonadIO m) => Transform -> m (Float, Float, Float, Float)
- transformToMatrix :: (HasCallStack, MonadIO m) => Transform -> m Matrix
- transformToString :: (HasCallStack, MonadIO m) => Transform -> m Text
- transformToTranslate :: (HasCallStack, MonadIO m) => Transform -> m (Float, Float)
- transformTransform :: (HasCallStack, MonadIO m) => Transform -> Maybe Transform -> m (Maybe Transform)
- transformTransformBounds :: (HasCallStack, MonadIO m) => Transform -> Rect -> m Rect
- transformTransformPoint :: (HasCallStack, MonadIO m) => Transform -> Point -> m Point
- transformTranslate :: (HasCallStack, MonadIO m) => Transform -> Point -> m (Maybe Transform)
- transformTranslate3d :: (HasCallStack, MonadIO m) => Transform -> Point3D -> m (Maybe Transform)
- transformUnref :: (HasCallStack, MonadIO m) => Transform -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq Transform Source # | |
GBoxed Transform Source # | |
Defined in GI.Gsk.Structs.Transform | |
ManagedPtrNewtype Transform Source # | |
Defined in GI.Gsk.Structs.Transform toManagedPtr :: Transform -> ManagedPtr Transform | |
TypedObject Transform Source # | |
Defined in GI.Gsk.Structs.Transform | |
HasParentTypes Transform Source # | |
Defined in GI.Gsk.Structs.Transform | |
IsGValue (Maybe Transform) Source # | Convert |
Defined in GI.Gsk.Structs.Transform gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Transform -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Transform) | |
type ParentTypes Transform Source # | |
Defined in GI.Gsk.Structs.Transform |
Methods
Click to display all available methods, including inherited ones
Methods
equal, invert, matrix, perspective, print, ref, rotate, rotate3d, scale, scale3d, skew, to2d, to2dComponents, toAffine, toMatrix, toString, toTranslate, transform, transformBounds, transformPoint, translate, translate3d, unref.
Getters
Setters
None.
equal
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Maybe Transform |
|
-> m Bool | Returns: |
Checks two transforms for equality.
getCategory
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> m TransformCategory | Returns: The category of the transform |
Returns the category this transform belongs to.
invert
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> m (Maybe Transform) | Returns: The inverted transform |
matrix
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Matrix |
|
-> m Transform | Returns: The new transform |
Multiplies next
with the given matrix
.
new
transformNew :: (HasCallStack, MonadIO m) => m Transform Source #
No description available in the introspection data.
parse
:: (HasCallStack, MonadIO m) | |
=> Text |
|
-> m (Bool, Transform) | Returns: |
Parses the given string
into a transform and puts it in
outTransform
.
Strings printed via transformToString
can be read in again successfully using this function.
If string
does not describe a valid transform, False
is
returned and Nothing
is put in outTransform
.
perspective
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Float |
|
-> m Transform | Returns: The new transform |
Applies a perspective projection transform.
This transform scales points in X and Y based on their Z value, scaling points with positive Z values away from the origin, and those with negative Z values towards the origin. Points on the z=0 plane are unchanged.
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> String |
|
-> m () |
Converts self
into a human-readable string representation suitable
for printing.
The result of this function can later be parsed with
[funcgsk
.Transform.parse].
ref
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> m (Maybe Transform) | Returns: the |
Acquires a reference on the given GskTransform
.
rotate
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Float |
|
-> m (Maybe Transform) | Returns: The new transform |
Rotates next
angle
degrees in 2D - or in 3D-speak, around the z axis.
rotate3d
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Float |
|
-> Vec3 |
|
-> m (Maybe Transform) | Returns: The new transform |
Rotates next
angle
degrees around axis
.
For a rotation in 2D space, use transformRotate
scale
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Float |
|
-> Float |
|
-> m (Maybe Transform) | Returns: The new transform |
Scales next
in 2-dimensional space by the given factors.
Use transformScale3d
to scale in all 3 dimensions.
scale3d
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Float |
|
-> Float |
|
-> Float |
|
-> m (Maybe Transform) | Returns: The new transform |
Scales next
by the given factors.
skew
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Float |
|
-> Float |
|
-> m (Maybe Transform) | Returns: The new transform |
Applies a skew transform.
Since: 4.6
to2d
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> m (Float, Float, Float, Float, Float, Float) |
Converts a GskTransform
to a 2D transformation matrix.
self
must be a 2D transformation. If you are not
sure, use transformGetCategory
>=
TransformCategory2d
to check.
The returned values have the following layout:
| xx yx | | a b 0 | | xy yy | = | c d 0 | | dx dy | | tx ty 1 |
This function can be used to convert between a GskTransform
and a matrix type from other 2D drawing libraries, in particular
Cairo.
to2dComponents
transformTo2dComponents Source #
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> m (Float, Float, Float, Float, Float, Float, Float) |
Converts a GskTransform
to 2D transformation factors.
To recreate an equivalent transform from the factors returned by this function, use
gsk_transform_skew ( gsk_transform_scale ( gsk_transform_rotate ( gsk_transform_translate (NULL, &GRAPHENE_POINT_T (dx, dy)), angle), scale_x, scale_y), skew_x, skew_y)
self
must be a 2D transformation. If you are not sure, use
transformGetCategory
>= TransformCategory2d
to check.
Since: 4.6
toAffine
Converts a GskTransform
to 2D affine transformation factors.
To recreate an equivalent transform from the factors returned by this function, use
gsk_transform_scale (gsk_transform_translate (NULL, &GRAPHENE_POINT_T (dx, dy)), sx, sy)
self
must be a 2D affine transformation. If you are not
sure, use
transformGetCategory
>= TransformCategory2dAffine
to check.
toMatrix
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> m Matrix |
Computes the actual value of self
and stores it in outMatrix
.
The previous value of outMatrix
will be ignored.
toString
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> m Text | Returns: A new string for |
Converts a matrix into a string that is suitable for printing.
The resulting string can be parsed with [funcgsk
.Transform.parse].
This is a wrapper around transformPrint
.
toTranslate
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> m (Float, Float) |
Converts a GskTransform
to a translation operation.
self
must be a 2D transformation. If you are not
sure, use
transformGetCategory
>= TransformCategory2dTranslate
to check.
transform
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Maybe Transform |
|
-> m (Maybe Transform) | Returns: The new transform |
Applies all the operations from other
to next
.
transformBounds
transformTransformBounds Source #
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Rect |
|
-> m Rect |
Transforms a graphene_rect_t
using the given transform self
.
The result is the bounding box containing the coplanar quad.
transformPoint
transformTransformPoint Source #
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Point |
|
-> m Point |
Transforms a graphene_point_t
using the given transform self
.
translate
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Point |
|
-> m (Maybe Transform) | Returns: The new transform |
Translates next
in 2-dimensional space by point
.
translate3d
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> Point3D |
|
-> m (Maybe Transform) | Returns: The new transform |
Translates next
by point
.
unref
:: (HasCallStack, MonadIO m) | |
=> Transform |
|
-> m () |
Releases a reference on the given GskTransform
.
If the reference was the last, the resources associated to the self
are
freed.