BodyInstance

class BodyInstance()

Constructors

constructor()

Properties

__BodyInstance
__BodyMixin
__NodeMixin
_bits
_instanceKey
_modifiers
_nodeId
override

Constructors

BodyInstance.constructor(assemblyTree, masterModelKey, parent, info)

Arguments:	assemblyTree (`IAssemblyTree()`) – None masterModelKey (`MasterModelKey()`) – None parent (BodyInstanceParent) – None info (`AnyBodyInfo()`) – None
Return type:	`BodyInstance()`

Properties

BodyInstance.__BodyInstance

Type:	PhantomMember

BodyInstance.__BodyMixin

Type:	PhantomMember

BodyInstance.__NodeMixin

Type:	PhantomMember

BodyInstance._bits

Type:	NodeBits \| AnyBodyBits

BodyInstance._instanceKey

Type:	InstanceKey

BodyInstance._modifiers

Type:	AnyBodyModifierBits

BodyInstance._nodeId

Type:	AuthoredNodeId \| DynamicNodeId

BodyInstance.override

Type:	any

Methods

_hasBits

BodyInstance._hasBits(bits)

Arguments:	bits (NodeBits \| AnyBodyBits) – None
Return type:	boolean

_setVisibility

BodyInstance._setVisibility(visible)

Arguments:	visible (`boolean()`) – None
Return type:	void

addAttribute

BodyInstance.addAttribute(attr)

Arguments:	attr (`Attribute()`) – None
Return type:	void

getAttributes

BodyInstance.getAttributes()

Return type:	Promise <[`Attribute()`]>

getAuthoredId

BodyInstance.getAuthoredId()

Return type:	AuthoredNodeId

getAuthoredLayerId

BodyInstance.getAuthoredLayerId()

Return type:	AuthoredLayerId \| null

getBodyRef

BodyInstance.getBodyRef()

Return type:	BodyId \| undefined

getExchangeId

BodyInstance.getExchangeId()

Return type:	ExchangeId \| null

getGenericId

BodyInstance.getGenericId()

Return type:	GenericId \| null

getGenericTypeId

BodyInstance.getGenericTypeId()

Return type:	GenericTypeId \| null

getInstanceInc

BodyInstance.getInstanceInc()

Return type:	InstanceInc

getInstanceKey

BodyInstance.getInstanceKey()

Return type:	InstanceKey

getLocalTransform

BodyInstance.getLocalTransform()

Return type:	Matrix16 \| null

getName

BodyInstance.getName()

Return type:	string

getParent

BodyInstance.getParent()

Return type:	BodyInstanceParent

getRuntimeId

BodyInstance.getRuntimeId()

Return type:	RuntimeNodeId

getUserData

BodyInstance.getUserData(index)

Arguments:	index (UserDataIndex) – None
Return type:	Uint8Array

getUserDataIndices

BodyInstance.getUserDataIndices()

Return type:	[UserDataIndex]

hasAuthoredId

BodyInstance.hasAuthoredId()

Return type:	boolean

hasLocalTransformOverride

BodyInstance.hasLocalTransformOverride()

Return type:	boolean

hasModifiers

BodyInstance.hasModifiers()

Return type:	boolean

ignoreParentRotation

BodyInstance.ignoreParentRotation()

Return type:	boolean

ignoreParentScale

BodyInstance.ignoreParentScale()

Return type:	boolean

isImplicitBody

BodyInstance.isImplicitBody()

Return type:	boolean

isInitiallyShown

BodyInstance.isInitiallyShown()

Return type:	boolean

isLoaded

BodyInstance.isLoaded()

Return type:	boolean

isOutOfHierarchy

BodyInstance.isOutOfHierarchy()

Return type:	boolean

isRequested

BodyInstance.isRequested()

Return type:	boolean

isVisible

BodyInstance.isVisible()

Return type:	boolean

markLoaded

BodyInstance.markLoaded()

Return type:	void

overrideLocalTransform

BodyInstance.overrideLocalTransform(matrix)

Arguments:	matrix (`Matrix16()`) – None
Return type:	void

preventFromResetting

BodyInstance.preventFromResetting()

Return type:	boolean

removeLocalTransformOverride

BodyInstance.removeLocalTransformOverride()

Return type:	void

setLocalTransformAsInitial

BodyInstance.setLocalTransformAsInitial(matrix)

Arguments:	matrix (`Matrix16()`) – None
Return type:	void

setRequested

BodyInstance.setRequested()

Return type:	void

setVisibility

BodyInstance.setVisibility(visible)

Arguments:	visible (`boolean()`) – None
Return type:	void

static createDynamic

BodyInstance.createDynamic(assemblyTree, inclusionKey, instanceKey, authoredId, name, parent, nodeBits, bodyBits)

Arguments:	assemblyTree (`IAssemblyTree()`) – None inclusionKey (`InclusionKey()`) – None instanceKey (`InstanceKey()`) – None authoredId (AuthoredNodeId \| null) – None name (`string \| null()`) – None parent (`ProductOccurrence()`) – None nodeBits (NodeBits) – None bodyBits (AnyBodyBits) – None
Return type:	`BodyInstance()`

static parseBinary

BodyInstance.parseBinary(assemblyTree, inclusionContext, parser, config)

Arguments:	assemblyTree (`IAssemblyTree()`) – None inclusionContext (`InclusionContext()`) – None parser (`AssemblyDataParser()`) – None config (`LoadSubtreeConfig()`) – None
Return type:	BodyInstanceInfo

static parseXml

BodyInstance.parseXml(assemblyTree, elem, inclusionKey, config)

Arguments:	assemblyTree (`IAssemblyTree()`) – None elem (`Element()`) – None inclusionKey (`InclusionKey()`) – None config (`LoadSubtreeConfig()`) – None
Return type:	BodyInstanceInfo

static reify

BodyInstance.reify(assemblyTree, masterModelKey, parent, info)

Arguments:	assemblyTree (`IAssemblyTree()`) – None masterModelKey (`MasterModelKey()`) – None parent (BodyInstanceParent) – None info (BodyInstanceInfo) – None
Return type:	`BodyInstance()`