#Class: WidgetComponentVolumeOutline experimental

component

Beta

#Extends

• WidgetComponentBase

#Properties

#componentType

readonly componentType: WidgetComponentType

Beta

#Throws

This property can throw when used.

InvalidWidgetComponentError

#Inherited from

WidgetComponentBase.componentType

---

#highlightHullColor

highlightHullColor: RGBA

World Mutation Beta

#Remarks

---

#highlightOutlineColor

highlightOutlineColor: RGBA

World Mutation Beta

#Remarks

---

#hullColor

hullColor: RGBA

World Mutation Beta

#Remarks

---

#location

readonly location: Vector3

Beta

#Throws

This property can throw when used.

InvalidWidgetComponentError

#Inherited from

WidgetComponentBase.location

---

#lockToSurface

lockToSurface: boolean

World Mutation Beta

#Remarks

#Inherited from

WidgetComponentBase.lockToSurface

---

#mirror

mirror: StructureMirrorAxis

World Mutation Beta

#Remarks

---

#name

readonly name: string

Beta

#Throws

This property can throw when used.

InvalidWidgetComponentError

#Inherited from

WidgetComponentBase.name

---

#normalizedOrigin

normalizedOrigin: Vector3

World Mutation Beta

#Remarks

---

#offset

offset: Vector3

World Mutation Beta

#Remarks

#Inherited from

WidgetComponentBase.offset

---

#outlineColor

outlineColor: RGBA

World Mutation Beta

#Remarks

---

#rotation

rotation: StructureRotation

World Mutation Beta

#Remarks

---

#showHighlightOutline

showHighlightOutline: boolean

World Mutation Beta

#Remarks

---

#showOutline

showOutline: boolean

World Mutation Beta

#Remarks

---

#transformedWorldVolume

readonly transformedWorldVolume: BlockVolume

Beta

#Throws

This property can throw when used.

InvalidWidgetComponentError

---

#valid

readonly valid: boolean

Beta

#Inherited from

WidgetComponentBase.valid

---

#visible

visible: boolean

Beta

#Inherited from

WidgetComponentBase.visible

---

#volumeOffset

volumeOffset: Vector3

World Mutation Beta

#Remarks

---

#widget

readonly widget: Widget

Beta

#Throws

This property can throw when used.

InvalidWidgetComponentError

#Inherited from

WidgetComponentBase.widget

#Methods

#delete()

delete(): void

World Mutation Beta

#Returns

void

#Remarks

#Throws

This function can throw errors.

InvalidWidgetComponentError

#Inherited from

WidgetComponentBase.delete

---

#getVolume()

getVolume(): RelativeVolumeListBlockVolume | undefined

World Mutation Beta

#Returns

RelativeVolumeListBlockVolume | undefined

#Remarks

#Throws

This function can throw errors.

InvalidWidgetComponentError

---

#setVolume()

setVolume(volumeToSet?): void

World Mutation Beta

#Parameters

#volumeToSet?

any

#Returns

void

#Remarks

#Throws

This function can throw errors.

InvalidWidgetComponentError

#同领域相关

• InvalidWidgetComponentError
• WidgetComponentBase
• WidgetComponentBaseOptions
• WidgetComponentBoundingBox
• WidgetComponentBoundingBoxLimit
• WidgetComponentBoundingBoxOptions