#Class: CylinderBrushShape experimental

Beta

#Extends

• BrushShape

#Constructors

#Constructor

new CylinderBrushShape(settings?): CylinderBrushShape

Beta

#Parameters

#settings?

#depth?

number

#enableHollowSettings?

boolean

#height?

number

#hideRotation?

boolean

#hollow?

boolean

#maxHeight?

number

#maxRadius?

number

#minRadius?

number

#radius?

number

#thickness?

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 Signature

get depth(): number

Beta

#Returns

number

---

#displayName

#Get Signature

get displayName(): string

Beta

#Returns

string

#Inherited from

BrushShape.displayName

---

#height

#Get Signature

get height(): number

Beta

#Returns

number

---

#icon

#Get Signature

get icon(): string

Beta

#Returns

string

#Inherited from

BrushShape.icon

---

#id

#Get Signature

get id(): string

Beta

#Returns

string

#Inherited from

BrushShape.id

---

#radius

#Get Signature

get radius(): number

Beta

#Returns

number

---

#uniform

#Get Signature

get uniform(): boolean

Beta

#Returns

boolean

---

#width

#Get Signature

get width(): number

Beta

#Returns

number

#Methods

#applySetting()

applySetting(brushSettings): void

Beta

#Parameters

#brushSettings

CylinderBrushShapeSettings

#Returns

void

#Overrides

BrushShape.applySetting

---

#calculateBounds()

calculateBounds(): BlockBoundingBox

Beta

#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.

#Overrides

BrushShape.calculateBounds

---

#createSettingsPane()

createSettingsPane(parentPane, onSettingsChange?, flatLayout?): ISubPanePropertyItem

Beta

#Parameters

#parentPane

IPropertyPane

#onSettingsChange?

() => void

#flatLayout?

boolean

#Returns

ISubPanePropertyItem

#Overrides

BrushShape.createSettingsPane

---

#createShape()

createShape(): RelativeVolumeListBlockVolume

Beta

#Returns

RelativeVolumeListBlockVolume

#Overrides

BrushShape.createShape

---

#createShapeAsync()

createShapeAsync(cancelToken?, yieldInterval?): Promise<RelativeVolumeListBlockVolume>

Beta

#Parameters

#cancelToken?

Optional token to cancel the operation. Set cancelled to true to abort.

#cancelled

boolean

#yieldInterval?

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.

#Overrides

BrushShape.createShapeAsync

---

#estimateBlockCount()

estimateBlockCount(): number

Beta

#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.

#Overrides

BrushShape.estimateBlockCount

---

#getSettings()

getSettings(): CylinderBrushShapeSettings

Beta

#Returns

CylinderBrushShapeSettings

#Overrides

BrushShape.getSettings