Skeleton

Skeleton class

The Skeleton is mainly used by CAD software to help designer to manipulate the transformation of skeletal structure, it’s usually useless outside the CAD softwares. To make the skeleton hierarchy acts like one object in CAD software, it’s necessary to mark the top Skeleton node as the root one by setting Type to SkeletonType.SKELETON, and all children set to SkeletonType.BONE

Methods

constructor

NameDescription
constructor()Initializes a new instance of the Skeleton class.

Result:


constructor_overload

NameDescription
constructor_overload(name)Initializes a new instance of the Skeleton class.

Parameters:

NameTypeDescription
nameStringName.

Result:


getSize

NameDescription
getSize()Gets or sets the limb node size that used in CAD software to represent the size of the bone.

Result:


setSize

NameDescription
setSize(value)Gets or sets the limb node size that used in CAD software to represent the size of the bone.

Result:


getType

NameDescription
getType()Gets or sets the type of the skeleton. The value of the property is SkeletonType integer constant.The type of the skeleton.

Result:


setType

NameDescription
setType(value)Gets or sets the type of the skeleton. The value of the property is SkeletonType integer constant.The type of the skeleton.

Result:


getParentNodes

NameDescription
getParentNodes()Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing The nodes.

Result:


getExcluded

NameDescription
getExcluded()Gets or sets whether to exclude this entity during exporting.

Result:


setExcluded

NameDescription
setExcluded(value)Gets or sets whether to exclude this entity during exporting.

Result:


getParentNode

NameDescription
getParentNode()Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. The parent node.

Result:


setParentNode

NameDescription
setParentNode(value)Gets or sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes. The parent node.

Result:


getScene

NameDescription
getScene()Gets the scene that this object belongs to

Result:


getName

NameDescription
getName()Gets or sets the name. The name.

Result:


setName

NameDescription
setName(value)Gets or sets the name. The name.

Result:


getProperties

NameDescription
getProperties()Gets the collection of all properties.

Result:


getBoundingBox

NameDescription
getBoundingBox()Gets the bounding box of current entity in its object space coordinate system.

Result:


getEntityRendererKey

NameDescription
getEntityRendererKey()Gets the key of the entity renderer registered in the renderer

Result: EntityRendererKey


removeProperty

NameDescription
removeProperty(property)Removes a dynamic property.

Parameters:

NameTypeDescription
propertyPropertyWhich property to remove

Result: boolean


removeProperty

NameDescription
removeProperty(property)Remove the specified property identified by name

Parameters:

NameTypeDescription
propertStringnull

Result: boolean


getProperty

NameDescription
getProperty(property)Get the value of specified property

Parameters:

NameTypeDescription
propertyStringProperty name

Result: Object


setProperty

NameDescription
setProperty(property, value)Sets the value of specified property

Parameters:

NameTypeDescription
propertyStringProperty name
valueObjectThe value of the property

Result: Object


findProperty

NameDescription
findProperty(propertyName)Finds the property. It can be a dynamic property (Created by CreateDynamicProperty/SetProperty) or native property(Identified by its name)

Parameters:

NameTypeDescription
propertyNameStringProperty name.

Result: Property