editor › Globals › ExternalObjectDescriptor

Class: ExternalObjectDescriptor

This model elements describes an external object, that is placed in an assembly such as the default coffee mug in the scene. It does not represent an Asset, that uses an ExternalObject for its representation.

Hierarchy

• ExternalObjectDescriptor

Implements

• IPositionableElement

Index

Constructors

• constructor

Properties

• assembly
• assetIdAndResourceName
• changeEventEmitter
• csgCutoutsEnabled
• scale
• transformsAnchor
• transformsChangeEventEmitter

Methods

• _onAnchorTransformsChange
• destroy
• getAssembly
• getAssetIdAndResourceName
• getChangeEventEmitter
• getCsgCutoutsEnabled
• getElementsThisDependsOn
• getIsValid
• getOBJ
• getParent
• getScale
• getTransforms
• getTransformsChangeEventEmitter
• getTransformsDefiner
• setAssembly
• setCsgCutoutsEnabled
• setScale
• setTransformsDefiner

Constructors

constructor

+ new ExternalObjectDescriptor(assetIdAndResourceName: string): ExternalObjectDescriptor

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:26

Parameters:

Name	Type
assetIdAndResourceName	string

Returns: ExternalObjectDescriptor

Properties

Private assembly

• assembly: Assembly = null

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:20

---

Private Readonly assetIdAndResourceName

• assetIdAndResourceName: string

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:28

---

Private Readonly changeEventEmitter

• changeEventEmitter: EventEmitter‹IModelElementEvent› = new EventEmitter()

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:22

---

Private csgCutoutsEnabled

• csgCutoutsEnabled: boolean = false

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:26

---

Private scale

• scale: Vector3‹› = new Vector3(1, 1, 1)

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:24

---

Private transformsAnchor

• transformsAnchor: IPositioningAnchor

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:21

---

Private Readonly transformsChangeEventEmitter

• transformsChangeEventEmitter: EventEmitter‹ITransformsChangeEvent› = new EventEmitter()

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:23

Methods

Private _onAnchorTransformsChange

▸ _onAnchorTransformsChange(event: ITransformsChangeEvent): void

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:134

Parameters:

Name	Type
event	ITransformsChangeEvent

Returns: void

---

destroy

▸ destroy(): void

Implementation of IPositionableElement

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:92

Returns: void

---

getAssembly

▸ getAssembly(): Assembly

Implementation of IPositionableElement

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:88

Returns: Assembly

---

getAssetIdAndResourceName

▸ getAssetIdAndResourceName(): string

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:30

Returns: string

---

getChangeEventEmitter

▸ getChangeEventEmitter(): IPublicEventEmitterInterface‹IModelElementEvent›

Implementation of IPositionableElement

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:61

Returns: IPublicEventEmitterInterface‹IModelElementEvent›

---

getCsgCutoutsEnabled

▸ getCsgCutoutsEnabled(): boolean

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:104

Returns: boolean

---

getElementsThisDependsOn

▸ getElementsThisDependsOn(): IModelElement[]

Implementation of IPositionableElement

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:54

Returns: IModelElement[]

---

getIsValid

▸ getIsValid(): boolean

Implementation of IPositionableElement

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:96

Returns: boolean

---

getOBJ

▸ getOBJ(): Promise‹string›

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:122

Returns: Promise‹string›

---

getParent

▸ getParent(): ITransformable

Implementation of IPositionableElement

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:77

Returns: ITransformable

---

getScale

▸ getScale(): ReadonlyVector3

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:100

Returns: ReadonlyVector3

---

getTransforms

▸ getTransforms(): IReadOnlyTransforms

Implementation of IPositionableElement

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:73

Returns: IReadOnlyTransforms

---

getTransformsChangeEventEmitter

▸ getTransformsChangeEventEmitter(): IPublicEventEmitterInterface‹ITransformsChangeEvent›

Implementation of IPositionableElement

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:65

Returns: IPublicEventEmitterInterface‹ITransformsChangeEvent›

---

getTransformsDefiner

▸ getTransformsDefiner(): IPositionableElementTransformsDefiner

Implementation of IPositionableElement

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:69

Returns: IPositionableElementTransformsDefiner

---

setAssembly

▸ setAssembly(assembly: Assembly): void

Implementation of IPositionableElement

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:84

Parameters:

Name	Type
assembly	Assembly

Returns: void

---

setCsgCutoutsEnabled

▸ setCsgCutoutsEnabled(csgCutoutsEnabled: boolean): void

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:108

Parameters:

Name	Type
csgCutoutsEnabled	boolean

Returns: void

---

setScale

▸ setScale(scale: ReadonlyVector3): this

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:112

Parameters:

Name	Type
scale	ReadonlyVector3

Returns: this

---

setTransformsDefiner

▸ setTransformsDefiner(transformsAnchor: IPositioningAnchor): this

Defined in src/model/data/Concepts/ExternalObjectDescriptor.ts:34

Parameters:

Name	Type
transformsAnchor	IPositioningAnchor

Returns: this