Class Joint

the Joint class

Hierarchy

IShape
- Joint

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Joint(): Joint

Inherited from IShape.constructor
- Defined in foundation/geometry/Primitive.ts:74
Returns Joint

Properties

Private __width

__width: number = 1

Private __worldPositionOfParentJoint

__worldPositionOfParentJoint: Vector3 = ...

Private __worldPositionOfThisJoint

__worldPositionOfThisJoint: Vector3 = ...

_prevMaterial

_prevMaterial: Material = ...

_sortkey

_sortkey: number = 0

_viewDepth

_viewDepth: number = 0

Static Readonly InvalidObjectUID

InvalidObjectUID: -1 = -1

Static currentMaxObjectCount

currentMaxObjectCount: number = 0

Accessors

AABB

get AABB(): AABB

Inherited from IShape.AABB
- Defined in foundation/geometry/Primitive.ts:392
Returns AABB

attributeAccessors

get attributeAccessors(): Accessor[]

Inherited from IShape.attributeAccessors
- Defined in foundation/geometry/Primitive.ts:326
Returns Accessor[]

attributeComponentTypes

get attributeComponentTypes(): ComponentTypeEnum[]

Inherited from IShape.attributeComponentTypes
- Defined in foundation/geometry/Primitive.ts:359
Returns ComponentTypeEnum[]

attributeCompositionTypes

get attributeCompositionTypes(): CompositionTypeEnum[]

Inherited from IShape.attributeCompositionTypes
- Defined in foundation/geometry/Primitive.ts:350
Returns CompositionTypeEnum[]

attributeEntries

get attributeEntries(): IterableIterator<[VertexAttributeSemanticsJoinedString, Accessor]>

Inherited from IShape.attributeEntries
- Defined in foundation/geometry/Primitive.ts:346
Returns IterableIterator<[VertexAttributeSemanticsJoinedString, Accessor]>

attributeSemantics

get attributeSemantics(): VertexAttributeSemanticsJoinedString[]

Inherited from IShape.attributeSemantics
- Defined in foundation/geometry/Primitive.ts:338
Returns VertexAttributeSemanticsJoinedString[]

indicesAccessor

get indicesAccessor(): undefined | Accessor

Inherited from IShape.indicesAccessor
- Defined in foundation/geometry/Primitive.ts:270
Returns undefined | Accessor

material

get material(): Material
set material(mat: Material): void

Inherited from IShape.material
- Defined in foundation/geometry/Primitive.ts:108
Returns Material
Inherited from IShape.material
- Defined in foundation/geometry/Primitive.ts:98
Parameters
- mat: Material
Returns void

mesh

get mesh(): undefined | IMesh

Inherited from IShape.mesh
- Defined in foundation/geometry/Primitive.ts:126
Returns undefined | IMesh

objectUID

get objectUID(): number

Inherited from IShape.objectUID
- Defined in foundation/core/RnObject.ts:68
Gets the objectUID of the object.

Returns number

positionAccessorVersion

get positionAccessorVersion(): undefined | number

Inherited from IShape.positionAccessorVersion
- Defined in foundation/geometry/Primitive.ts:376
Returns undefined | number

primitiveMode

get primitiveMode(): EnumIO

Inherited from IShape.primitiveMode
- Defined in foundation/geometry/Primitive.ts:368
Returns EnumIO

primitiveUid

get primitiveUid(): number

Inherited from IShape.primitiveUid
- Defined in foundation/geometry/Primitive.ts:372
Returns number

targets

get targets(): Attributes[]

Inherited from IShape.targets
- Defined in foundation/geometry/Primitive.ts:444
Returns Attributes[]

uniqueName

get uniqueName(): string

Inherited from IShape.uniqueName
- Defined in foundation/core/RnObject.ts:238
Get the unique name of the entity.

Returns string

vertexHandles

get vertexHandles(): undefined | VertexHandles

Inherited from IShape.vertexHandles
- Defined in foundation/geometry/Primitive.ts:499
Returns undefined | VertexHandles

Static headerAccessor

get headerAccessor(): undefined | Accessor

Inherited from IShape.headerAccessor
- Defined in foundation/geometry/Primitive.ts:170
Returns undefined | Accessor

Static maxPrimitiveCount

get maxPrimitiveCount(): number

Inherited from IShape.maxPrimitiveCount
- Defined in foundation/geometry/Primitive.ts:166
Returns number

Methods

_backupMaterial

_backupMaterial(): void

Inherited from IShape._backupMaterial
- Defined in foundation/geometry/Primitive.ts:130
Returns void

_belongToMesh

_belongToMesh(mesh: IMesh): void

Inherited from IShape._belongToMesh
- Defined in foundation/geometry/Primitive.ts:121
belong to mesh (weak reference)

Parameters
- mesh: IMesh
Returns void

_copyFrom

_copyFrom(rnObject: RnObject): void

Inherited from IShape._copyFrom
- Defined in foundation/core/RnObject.ts:252
Parameters
- rnObject: RnObject
Returns void

_restoreMaterial

_restoreMaterial(): void

Inherited from IShape._restoreMaterial
- Defined in foundation/geometry/Primitive.ts:134
Returns void

applyMaterialVariant

applyMaterialVariant(variantName: string): void

Inherited from IShape.applyMaterialVariant
- Defined in foundation/geometry/Primitive.ts:82
Parameters
- variantName: string
Returns void

castRay

castRay(origVec3: IVector3, dirVec3: IVector3, isFrontFacePickable: boolean, isBackFacePickable: boolean, dotThreshold: number, hasFaceNormal: boolean): RaycastResultEx1

Inherited from IShape.castRay
- Defined in foundation/geometry/Primitive.ts:503
Parameters
- origVec3: IVector3
- dirVec3: IVector3
- isFrontFacePickable: boolean
- isBackFacePickable: boolean
- dotThreshold: number
- hasFaceNormal: boolean
Returns RaycastResultEx1

copyVertexData

copyVertexData(__namedParameters: PrimitiveDescriptor): void

Inherited from IShape.copyVertexData
- Defined in foundation/geometry/Primitive.ts:174
Parameters
- __namedParameters: PrimitiveDescriptor
Returns void

create3DAPIVertexData

create3DAPIVertexData(): boolean

Inherited from IShape.create3DAPIVertexData
- Defined in foundation/geometry/Primitive.ts:459
Returns boolean

delete3DAPIVertexData

delete3DAPIVertexData(): boolean

Inherited from IShape.delete3DAPIVertexData
- Defined in foundation/geometry/Primitive.ts:487
Returns boolean

generate

generate(desc: IAnyPrimitiveDescriptor): void

Overrides IShape.generate
- Defined in foundation/geometry/shapes/Joint.ts:20
Generates a joint object

Parameters
- desc: IAnyPrimitiveDescriptor
Returns void

getAttribute

getAttribute(semantic: VertexAttributeSemanticsJoinedString): undefined | Accessor

Inherited from IShape.getAttribute
- Defined in foundation/geometry/Primitive.ts:334
Parameters
- semantic: VertexAttributeSemanticsJoinedString
Returns undefined | Accessor

getBlendShapeTargets

getBlendShapeTargets(): Attributes[]

Inherited from IShape.getBlendShapeTargets
- Defined in foundation/geometry/Primitive.ts:440
Returns Attributes[]

getTag

getTag(tagName: string): Tag

Inherited from IShape.getTag
- Defined in foundation/core/RnObject.ts:156
Gets the tag object.

Parameters
- tagName: string
  
  The tag name.
Returns Tag

getTagValue

getTagValue(tagName: string): any

Inherited from IShape.getTagValue
- Defined in foundation/core/RnObject.ts:148
Gets the value of the tag.

Parameters
- tagName: string
  
  The tag name.
Returns any

getTriangleCountAsIndicesBased

getTriangleCountAsIndicesBased(): number

Inherited from IShape.getTriangleCountAsIndicesBased
- Defined in foundation/geometry/Primitive.ts:289
Returns number

getTriangleCountAsVerticesBased

getTriangleCountAsVerticesBased(): number

Inherited from IShape.getTriangleCountAsVerticesBased
- Defined in foundation/geometry/Primitive.ts:306
Returns number

getVariantMaterial

getVariantMaterial(variantName: string): undefined | Material

Inherited from IShape.getVariantMaterial
- Defined in foundation/geometry/Primitive.ts:94
Parameters
- variantName: string
Returns undefined | Material

getVariantNames

getVariantNames(): string[]

Inherited from IShape.getVariantNames
- Defined in foundation/geometry/Primitive.ts:90
Returns string[]

getVertexCountAsIndicesBased

getVertexCountAsIndicesBased(): number

Inherited from IShape.getVertexCountAsIndicesBased
- Defined in foundation/geometry/Primitive.ts:274
Returns number

getVertexCountAsVerticesBased

getVertexCountAsVerticesBased(): number

Inherited from IShape.getVertexCountAsVerticesBased
- Defined in foundation/geometry/Primitive.ts:282
Returns number

hasIndices

hasIndices(): boolean

Inherited from IShape.hasIndices
- Defined in foundation/geometry/Primitive.ts:322
Returns boolean

hasTag

hasTag(tagName: string): boolean

Inherited from IShape.hasTag
- Defined in foundation/core/RnObject.ts:168
Gets the boolean value whether this object has the tag or not.

Parameters
- tagName: string
  
  The tag name.
Returns boolean

isBlend

isBlend(): boolean

Inherited from IShape.isBlend
- Defined in foundation/geometry/Primitive.ts:448
Returns boolean

isOpaque

isOpaque(): boolean

Inherited from IShape.isOpaque
- Defined in foundation/geometry/Primitive.ts:455
Returns boolean

matchTag

matchTag(tagName: string, tagValue: string): boolean

Inherited from IShape.matchTag
- Defined in foundation/core/RnObject.ts:191
Confirms the matching of the tag name and tag value.

Parameters
- tagName: string
  
  The tag name.
- tagValue: string
  
  The tag value.
Returns boolean

matchTags

matchTags(tags: RnTags): boolean

Inherited from IShape.matchTags
- Defined in foundation/core/RnObject.ts:221
Confirm that this object's tags includes given set of tags.

Parameters
- tags: RnTags
  
  The set of tags.
Returns boolean

matchTagsAsFreeStrings

matchTagsAsFreeStrings(stringArray: string[]): boolean

Inherited from IShape.matchTagsAsFreeStrings
- Defined in foundation/core/RnObject.ts:203
Confirm that this object's tags includes given an array of string.

Parameters
- stringArray: string[]
  
  an array of string.
Returns boolean

removeIndices

removeIndices(): void

Inherited from IShape.removeIndices
- Defined in foundation/geometry/Primitive.ts:428
Returns void

removeTag

removeTag(tagName: string): void

Inherited from IShape.removeTag
- Defined in foundation/core/RnObject.ts:180
Remove the tag.

Parameters
- tagName: string
  
  The tag name.
Returns void

setBlendShapeTargets

setBlendShapeTargets(targets: Attributes[]): void

Inherited from IShape.setBlendShapeTargets
- Defined in foundation/geometry/Primitive.ts:436
Parameters
- targets: Attributes[]
Returns void

setData

setData(attributes: Attributes, mode: EnumIO, material?: Material, indicesAccessor?: Accessor): void

Inherited from IShape.setData
- Defined in foundation/geometry/Primitive.ts:142
Parameters
- attributes: Attributes
- mode: EnumIO
- Optional material: Material
- Optional indicesAccessor: Accessor
Returns void

setIndices

setIndices(accessor: Accessor): void

Inherited from IShape.setIndices
- Defined in foundation/geometry/Primitive.ts:432
Parameters
- accessor: Accessor
Returns void

setMaterialVariant

setMaterialVariant(variantName: string, material: Material): void

Inherited from IShape.setMaterialVariant
- Defined in foundation/geometry/Primitive.ts:78
Parameters
- variantName: string
- material: Material
Returns void

setSortKey

setSortKey(offset: number, value: number): void

Inherited from IShape.setSortKey
- Defined in foundation/geometry/Primitive.ts:112
Parameters
- offset: number
- value: number
Returns void

setVertexAttribute

setVertexAttribute(accessor: Accessor, vertexSemantic: VertexAttributeSemanticsJoinedString): void

Inherited from IShape.setVertexAttribute
- Defined in foundation/geometry/Primitive.ts:421
Parameters
- accessor: Accessor
- vertexSemantic: VertexAttributeSemanticsJoinedString
Returns void

tryToSetTag

tryToSetTag(tag: Tag): boolean

Inherited from IShape.tryToSetTag
- Defined in foundation/core/RnObject.ts:131
Tries to set tag (name and value).

Parameters
- tag: Tag
Returns boolean

tryToSetUniqueName

tryToSetUniqueName(name: string, toAddNameIfConflict: boolean): boolean

Inherited from IShape.tryToSetUniqueName
- Defined in foundation/core/RnObject.ts:93
Try to set a unique name of the entity.

Parameters
- name: string
- toAddNameIfConflict: boolean
  
  If true, force to add name string to the current unique name string. If false, give up to change name.
Returns boolean

update3DAPIVertexData

update3DAPIVertexData(): boolean

Inherited from IShape.update3DAPIVertexData
- Defined in foundation/geometry/Primitive.ts:471
Returns boolean

validateTagString

validateTagString(val: string): boolean

Inherited from IShape.validateTagString
- Defined in foundation/core/RnObject.ts:118
Validate the string of tags.

Parameters
- val: string
  
  The string to be validated
Returns boolean

Static _reset

_reset(): void

Inherited from IShape._reset
- Defined in foundation/core/RnObject.ts:245
internal
Returns void

Static createPrimitive

createPrimitive(desc: PrimitiveDescriptor): Primitive

Inherited from IShape.createPrimitive
- Defined in foundation/geometry/Primitive.ts:264
Parameters
- desc: PrimitiveDescriptor
Returns Primitive

Static getPrimitive

getPrimitive(primitiveUid: number): Primitive

Inherited from IShape.getPrimitive
- Defined in foundation/geometry/Primitive.ts:138
Parameters
- primitiveUid: number
Returns Primitive

Static getRnObject

getRnObject(objectUid: number): RnObject

Inherited from IShape.getRnObject
- Defined in foundation/core/RnObject.ts:76
Gets the object by corresponding to the objectUID.

Parameters
- objectUid: number
  
  The objectUID of the object.
Returns RnObject

Static getRnObjectByName

getRnObjectByName(uniqueName: string): undefined | RnObject

Inherited from IShape.getRnObjectByName
- Defined in foundation/core/RnObject.ts:84
Gets the object by the unique name.

Parameters
- uniqueName: string
  
  The unique name of the object.
Returns undefined | RnObject

Static searchByTag

searchByTag(tag: string, value: string): undefined | RnObject

Inherited from IShape.searchByTag
- Defined in foundation/core/RnObject.ts:56
Parameters
- tag: string
- value: string
Returns undefined | RnObject

Generated using TypeDoc