Class CylinderBrushShape

Base for creating new brush shapes

Hierarchy (View Summary)

BrushShape
- CylinderBrushShape

Index

Constructors

Accessors

depth displayName height icon id radius uniform width

Methods

applySetting calculateBounds createSettingsPane createShape createShapeAsync estimateBlockCount getSettings

Constructors

constructor

new CylinderBrushShape(
    settings?: {
        depth?: number;
        height?: number;
        hideRotation?: boolean;
        minRadius?: number;
        radius?: number;
        uniform?: boolean;
        width?: number;
        xRotation?: number;
        yRotation?: number;
        zRotation?: number;
    },
): CylinderBrushShape
Parameters
- Optionalsettings: {
      depth?: number;
      height?: number;
      hideRotation?: boolean;
      minRadius?: number;
      radius?: number;
      uniform?: boolean;
      width?: number;
      xRotation?: number;
      yRotation?: number;
      zRotation?: number;
  }
Returns CylinderBrushShape
Remarks
Constructs a new instance of the CylinderBrushShape class

Overrides BrushShape.constructor

Accessors

depth

get depth(): number
Returns number

displayName

get displayName(): string
Returns string
Inherited from BrushShape.displayName

height

get height(): number
Returns number

icon

get icon(): string
Returns string
Inherited from BrushShape.icon

id

get id(): string
Returns string
Inherited from BrushShape.id

radius

get radius(): number
Returns number

uniform

get uniform(): boolean
Returns boolean

width

get width(): number
Returns number

Methods

applySetting

applySetting(brushSettings: CylinderBrushShapeSettings): void
Parameters
- brushSettings: CylinderBrushShapeSettings
Returns void
Overrides BrushShape.applySetting

calculateBounds

calculateBounds(): BlockBoundingBox
Returns BlockBoundingBox
Object with min and max Vector3 bounds

Remarks
Calculates the bounding box of the shape in local coordinates. Used for region allocation before shape placement.

World Ready
This function can't be called in early-execution mode.

Overrides BrushShape.calculateBounds

createSettingsPane

createSettingsPane(
parentPane: IPropertyPane,
onSettingsChange?: () => void,
): ISubPanePropertyItem
Parameters
- parentPane: IPropertyPane
- OptionalonSettingsChange: () => void
Returns ISubPanePropertyItem
Overrides BrushShape.createSettingsPane

createShape

createShape(): RelativeVolumeListBlockVolume
Returns RelativeVolumeListBlockVolume
Overrides BrushShape.createShape

createShapeAsync

createShapeAsync(
cancelToken?: { cancelled: boolean },
yieldInterval?: number,
): Promise<RelativeVolumeListBlockVolume>
Parameters
- OptionalcancelToken: { cancelled: boolean }
  Optional token to cancel the operation. Set cancelled to true to abort.
- OptionalyieldInterval: number
  Number of blocks to process before yielding. Default is 10000.
Returns Promise<RelativeVolumeListBlockVolume>
Promise that resolves to the shape positions as Vector3 array.

Remarks
Asynchronously creates the shape, yielding control periodically to avoid timeouts. Use this for large shapes where createShape() may timeout.

World Ready
This function can't be called in early-execution mode.

Overrides BrushShape.createShapeAsync

estimateBlockCount

estimateBlockCount(): number
Returns number
Estimated block count

Remarks
Returns a mathematical estimate of the number of blocks in the shape. Used for UI display and validation before shape creation.

World Ready
This function can't be called in early-execution mode.

Overrides BrushShape.estimateBlockCount

getSettings

getSettings(): CylinderBrushShapeSettings
Returns CylinderBrushShapeSettings
Overrides BrushShape.getSettings