Internal_The index of this shape within the array of shapes in its parent. See foundry.data.fields.ShapesField.
The source data object for this DataModel instance. Once constructed, the source object is sealed such that no keys may be added nor removed.
An immutable reverse-reference to a parent DataModel to which this model belongs.
Static Internal_The defined and cached Data Schema for all instances of this DataModel.
StaticLOCALIZATION_StaticTYPEThe type of this shape.
The area of this shape.
The bounds of this Region.
The value of this property must not be mutated.
The center point of this shape.
The Clipper paths of this shape. The winding numbers are 1 or 0.
The value of this property must not be mutated.
The Clipper polygon tree of this shape.
The value of this property must not be mutated.
The control handles of this shape. Each handle has a position and a rotation in radians.
The grid that this shape is placed in.
The gridless version of the grid that this shape is placed in.
Is the current state of this DataModel invalid? The model is invalid if there is any unresolved failure.
Is this shape currently affected by the grid?
Is this shape empty?
The measured segments of this shape. Each segment consist of a ray, winding order, distance in grid units, and the angle in degrees if it has one. The ray represents the measured segment. If the winding order is ...
The distance is the actual grid distance if the shape is grid-based. Otherwise the distance is the distance in pixels divided by of the ratio of grid distance and grid size.
The origin of this shape.
The polygons of this shape.
The value of this property must not be mutated.
The polygon tree of this shape.
The value of this property must not be mutated.
Define the data schema for this document instance.
The triangulation of this shape.
The value of this property must not be mutated.
An array of validation failure instances which may have occurred when this instance was last validated.
StaticschemaThe Data Schema for all instances of this DataModel.
StaticTYPESThe possible shape types.
InternalGet the size for the given ray defined by a length and direction.
The length of the ray in pixels.
The direction of the ray in radians.
Optionaloptions: { allowZero?: boolean; round?: boolean; snap?: boolean } = {}Additional options.
OptionalallowZero?: booleanAllow the size to be zero?
Optionalround?: booleanRound the size to integer?
Optionalsnap?: booleanSnap the size to with defined grid snapping precision?
The snapped size in pixels.
InternalCreate a measured segment.
The x-coordinate of the origin of the ray.
The y-coordinate of the origin of the ray.
The direction of the ray in degrees.
The length of the ray in pixels.
The alignment of the ray.
The winding order.
Optionalangle: numberThe angle in degrees.
InternalCreate a ray.
The x-coordinate of the origin of the ray.
The y-coordinate of the origin of the ray.
The direction of the ray in degrees.
The length of the ray in pixels.
Optionalalignment: number = 0The alignment to ray.
InternalSnap the given rotation.
The rotation to be snapped in degrees.
The snapped rotation in degrees.
InternalTransform this shape by moving a rotation handle.
The direction of the rotation handle in degrees.
The handle destination.
Snap?
InternalTransform this shape by moving a scale handle.
The field name of the axis that is scaled.
The origin.
The direction of the axis in degrees.
The alignment of the axis.
The handle destination.
Snap?
OptionalallowZero: booleanAllow zero size?
Optionalmax: numberThe maximum value.
InternalTransform this shape by moving the sweep handle.
The maximum angle possible.
The handle destination.
Snap?
Draw reference lines of the shape into the Graphics element, if it has any.
The Graphics element
Draw the shape into the Graphics element.
The Graphics element
Traverse the data model instance, obtaining the DataField definition for a field of a particular property.
A property key like ["abilities", "strength"] or "abilities.strength"
The corresponding DataField definition for that field, or undefined
Reset the state of this data instance back to mirror the contained source data, erasing any changes.
Test whether given point is contained within this shape.
The point.
Extract the source data for the DataModel into a simple object format that can be serialized.
The document source data expressed as a plain object
Copy and transform the DataModel into a plain object. Draw the values of the extracted object from the data source (by default) otherwise from its transformed values.
Optionalsource: boolean = trueDraw values from the underlying data source rather than transformed values
The extracted primitive object
Update the DataModel locally by applying an object of changes to its source data. The provided changes are expanded, cleaned, validated, and stored to the source data object for this model. The provided changes argument is mutated in this process. The source data is then re-initialized to apply those changes to the prepared data. The method returns an object of differential changes which modified the original data.
New values which should be applied to the data model
Options which determine how the new data is merged
An object containing differential keys and values that were changed
Validate the data contained in the document to check for type and content. This method is intended to validate complete model records, verifying both individual field validation as well as joint model validity.
For validating sets of partial model changes, it is preferred to call DataModel#updateSource as a dryRun. This
method provides a convenience alias for such a workflow if changes are provided.
Warning: if fallback handling is allowed, this process will mutate provided changes or model source data.
Options which modify how the model is validated
Whether the data source or proposed change is reported as valid. A boolean is always returned if validation is non-strict.
Protected_ProtectedCalculate the area of this shape.
Protected_ProtectedConfigure the data model instance before validation and initialization workflows are performed.
Optionaloptions: object = {}Additional options modifying the configuration
Protected_Protected_ProtectedA generator that orders the DataFields in the DataSchema into an expected initialization order.
Protected_ProtectedInitialize the instance by copying data from the source object to instance attributes. This mirrors the workflow of SchemaField#initialize but with some added functionality.
Optionaloptions: object = {}Options provided to the model constructor
Protected_ProtectedInitialize the source data for a new DataModel instance. One-time migrations and initial cleaning operations are applied to the source data.
The candidate source data from which the model will be constructed
Optionaloptions: DataModelConstructionContext = {}Options provided to the model constructor
Migrated and cleaned source data which will be stored to the model instance,
which is the same object as the data argument
Protected_ProtectedCalled when the grid this shape is placed in changes.
The changes to the grid.
Protected_ProtectedCalled when the shape was changed. This function is not called when just the hole state is changed. This function is not called if grid-based is changed and the grid is gridless.
Protected_ProtectedPrepare the state object that is transacted through an updateSource operation.
New values which should be applied to the data model
Options which determine how the new data is merged
Data model update state
Protected_ProtectedPerform the first step of the DataModel#_updateSource workflow which applies changes to a copy of model source data and records the resulting diff.
A mutable copy of model source data
New values which should be applied to the data model
Options which determine how the new data is merged
Data cleaning state
The resulting difference applied to source data
Static_InternalConvert a path to a clipper path.
A path
StaticcleanClean a data source object to conform to a specific provided schema.
Optionaldata: object = {}Provided model data that requires cleaning
Optionaloptions: DataModelCleaningOptions = {}Options that configure how data cleaning is performed
Optional_state: Partial<data.types.DataModelUpdateState> = {}Internal options used during cleaning recursion
Cleaned data which is suitable for validation and usage
StaticdefineStaticfromCreate a DataModel instance using a provided serialized JSON string.
Serialized document data in string format
A constructed data model instance
StaticfromCreate a new instance of this DataModel from a source record. The source data is presumed trustworthy and is not strictly validated unless explicitly requested.
Initial document data which comes from a trusted source.
Optionalcontext: Omit<DataModelConstructionContext, "strict"> & DataModelFromSourceOptions = {}Model construction context
StaticmigrateMigrate candidate source data for this DataModel which may require initial cleaning or transformations.
Candidate source data for the module, before further cleaning
Optionaloptions: Readonly<DataModelCleaningOptions>Additional options for how the field is cleaned
Optional_state: data.types.DataModelUpdateStateInternal state variables which are used during recursion
Migrated source data, ready for further cleaning
StaticmigrateWrap data migration in a try/catch which attempts it safely.
Candidate source data for the module, before further cleaning
Optionaloptions: Readonly<DataModelCleaningOptions> = {}Additional options for how the field is cleaned
Migrated source data, ready for further cleaning
StaticshimTake data which conforms to the current data schema and add backwards-compatible accessors to it in order to support older code which uses this data.
Data which matches the current schema
Optionaloptions: { embedded?: boolean } = {}Additional shimming options
Optionalembedded?: booleanApply shims to embedded models?
Data with added backwards-compatible properties, which is the same object as
the data argument
StaticvalidateEvaluate joint validation rules which apply validation conditions across multiple fields of the model. Field-specific validation rules should be defined as part of the DataSchema for the model. This method allows for testing aggregate rules which impose requirements on the overall model.
Candidate data for the model
Protected Static_ProtectedApply final custom model-specific cleaning rules after data schema fields are cleaned. Subclass models can implement this function as an ideal place to apply custom imputation or cleaning. Cleaning must be done in-place rather than returning a different object.
The provided input data for cleaning
Options which define how cleaning was performed
The data cleaning state
The original data object, with cleaning performed inplace
Protected Static_ProtectedApply preliminary model-specific cleaning rules or alter cleaning options or initial state. Subclass models may implement this function to configure the cleaning workflow. Any mutations to data, options, or _state parameters are performed inplace.
The provided input data for cleaning
Options which define how cleaning should be performed
The data cleaning state
The data model for a polygon shape.