Gjsify LogoGjsify Logo

#ClutterPaintVolume is an opaque structure whose members cannot be directly accessed.

A #ClutterPaintVolume 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 #ClutterPaintVolume for a #ClutterActor 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.

record

Hierarchy

  • PaintVolume

Index

Constructors

Properties

name: string

Methods

  • free(): void
  • getDepth(): number
  • 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, clutter_actor_get_transformed_paint_volume() 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 clutter_actor_get_transformed_paint_volume() 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.

    Returns number

  • getHeight(): number
  • 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, clutter_actor_get_transformed_paint_volume() 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 clutter_actor_get_transformed_paint_volume() 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.

    Returns number

  • getWidth(): number
  • 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, clutter_actor_get_transformed_paint_volume() 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 clutter_actor_get_transformed_paint_volume() 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.

    Returns number

  • setDepth(depth: number): void
  • Sets the depth of the paint volume. The depth is measured along the z axis in the actor coordinates that pv is associated with.

    Parameters

    • depth: number

      the depth of the paint volume, in pixels

    Returns void

  • Sets the #ClutterPaintVolume from the allocation of actor.

    This function should be used when overriding the #ClutterActorClass.get_paint_volume() by #ClutterActor 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); }


    @param actor a #ClutterActor

    Parameters

    Returns boolean

  • setHeight(height: number): void
  • Sets the height of the paint volume. The height is measured along the y axis in the actor coordinates that pv is associated with.

    Parameters

    • height: number

      the height of the paint volume, in pixels

    Returns void

  • setOrigin(origin: Vertex): void
  • 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)

    Parameters

    • origin: Vertex

      a #ClutterVertex

    Returns void

  • setWidth(width: number): void
  • Sets the width of the paint volume. The width is measured along the x axis in the actor coordinates that pv is associated with.

    Parameters

    • width: number

      the width of the paint volume, in pixels

    Returns void

  • Updates the geometry of pv to encompass pv and another_pv.

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

    Parameters

    • anotherPv: PaintVolume

      A second #ClutterPaintVolume to union with pv

    Returns void

  • Unions the 2D region represented by box to a #ClutterPaintVolume.

    This function is similar to clutter_paint_volume_union(), but it is specific for 2D regions.

    Parameters

    • box: ActorBox

      a #ClutterActorBox to union to pv

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method