API reference

CompositeMaskAdd Class

Extends Mask2D
A mask that combines multiple other masks and adds their values together.

Methods

Check ( c )
Checks if the candidate is valid for the given mask.
Signature
override bool Check(Candidate c)
Parameters
c: Candidate  Candidate with the information from the distribution
Returns
override bool  true if valid
SampleMask ( c )
This method applies the mask to the given candidate.
It first generates an affine transformation based on the provided parameters, and then applies this transformation to the local position of the candidate. The resulting position is used to sample the mask layers, which are combined to produce a final value that represents the mask for the candidate.
Signature
override float SampleMask(Candidate c)
Parameters
c: Candidate  The candidate to apply the mask to.
Returns
override float  The mask value for the given candidate.

Inner Struct

MaskLayer Struct

The settings for the mask layer.

Fields

mask : Mask
Signature
Mask mask
outputLimitMax : float
The minimum value of the mask output.
Signature
float outputLimitMax
outputLimitMin : float
The scale of the mask output.
Signature
float outputLimitMin
outputOffset : float
The maximum value of the mask output.
Signature
float outputOffset
outputScale : float
The mask to use for this layer.
Signature
float outputScale

Methods

SampleMask ( c )
The offset of the mask output.
The constructor for the mask layer.
Signature
float SampleMask(Candidate c)
Parameters
c: Candidate  Candidate with the information from the distribution
Returns
float  The adjusted and clamped value