Class HatchBrush

Represents a hatch brush.

Hierarchy (View Summary)

Brush
- HatchBrush

Index

Constructors

Accessors

backColor foreColor id om style type

Methods

Constructors

constructor

new HatchBrush(hatchBrushProperties: HatchBrushProperties): HatchBrush
Creates a hatch brush with specified properties.
Parameters
- hatchBrushProperties: HatchBrushProperties
  The settings for creating a brush with hatch style.
Returns HatchBrush
Example
```
const brush = new HatchBrush({
    style: HatchStyle.LargeConfetti,
    backColor: "Navy",
    foreColor: "White"
});
```
Overrides Brush.constructor
new HatchBrush(
om: ObjectManager,
hatchBrushProperties: HatchBrushProperties,
): HatchBrush
Creates a hatch brush with specified properties.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the HatchBrush object.
- hatchBrushProperties: HatchBrushProperties
  The settings for creating a brush with hatch style.
Returns HatchBrush
Overrides Brush.constructor

Accessors

backColor

get backColor(): Color
Gets the color of spaces between the hatch lines.

Returns Color

foreColor

get foreColor(): Color
Gets the color of hatch lines.

Returns Color

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from Brush.id

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from Brush.om

style

get style(): HatchStyle
Gets the hatch style of the HatchBrush.

Returns HatchStyle

type

get type(): BrushType
Gets the type of the brush.

Returns BrushType
Overrides Brush.type

Methods

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from Brush.free

rebind

rebind(omTo: ObjectManager): void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
- omTo: ObjectManager
  The new ObjectManager for the object.
Returns void
Inherited from Brush.rebind