Pyramid.Combine

Description

Name

class Tinman.Pyramid.Combine

Derived from

Pyramid

Combines the first pixel pyramid with the second one.

Fields / Required

first

Type

Pyramid

Constraint

# != null

The first pixel pyramid.


second

Type

Pyramid

Constraint

# != null

The second pixel pyramid.

Fields / Optional

op

Type

ColorOp

Default

ColorOp.Blend

The color operation to use for combining the pyramid tile pixels.


union

Type

bool

Default

false

Computes the union of the first and second pyramid (true); the following table shows the combinations for this function (header row := first, header column := second):

      | Error | Void  | Ok    | Empty |
------+-------+-------+-------+-------+
Error | Error | Error | Error | Error |
------+-------+-------+-------+-------+
Void  | Error | Void  | Ok    | Empty |
------+-------+-------+-------+-------+
Ok    | Error | Ok    | Ok    | Ok    |
------+-------+-------+-------+-------+
Empty | Error | Empty | Ok    | Empty |
------+-------+-------+-------+-------+

Computes the intersection of the first and second pyramid (false); the following table shows the combinations for this function (header row := first, header column := second):

      | Error | Void  | Ok    | Empty |
------+-------+-------+-------+-------+
Error | Error | Error | Error | Error |
------+-------+-------+-------+-------+
Void  | Void  | Void  | Void  | Void  |
------+-------+-------+-------+-------+
Ok    | Error | Void  | Ok    | Ok    |
------+-------+-------+-------+-------+
Empty | Error | Void  | Ok    | Empty |
------+-------+-------+-------+-------+

scale

Type

number

Default

0

Determines whether the first resp. second pyramid will be scaled up to the full size of the resulting pyramid, if necessary:

  • < 0
    The first pyramid will be used as is, i.e. it will return Void for non-existing levels.
    The second pyramid will be scaled up to the full size of the resulting pyramid, if necessary.

  • = 0
    The first pyramid will be scaled up to the full size of the resulting pyramid, if necessary.
    The second pyramid will be scaled up to the full size of the resulting pyramid, if necessary.

  • > 0
    The first pyramid will be scaled up to the full size of the resulting pyramid, if necessary.
    The second pyramid will be used as is, i.e. it will return Void for non-existing levels.

Defaults to 0.

Fields / External

info

Holds detail information about this pixel pyramid.