Interface AncestryInstanceMetadataInterface

The AncestryInstanceMetadataInterface extends the InstanceMetadataInterface by providing the cumulated matrix of the given part instance.

The cumulated matrix is therefore the World Matrix of the given part instance.

The AncestryInstanceMetadataInterface is included in the PartInstanceInfoInterface, which is retrieved by an IdCardGetterInterface.

Please refer to PartInstanceInfoInterface to get more information about metadata requests.


Data Retrievers

See

PartInstanceInfoInterface

interface AncestryInstanceMetadataInterface {
    getAnnotationGroups(): AnnotationGroupInfoInterface[];
    getAttachedDocumentInfos(): AttachedDocumentInfoInterface[];
    getClassId(): number;
    getCumulatedXForm(): Matrix4;
    getInstanceDepth(): number;
    getInstanceId(): number;
    getInstanceSecurityTags(): string[];
    getInstancesMetadataDocuments(): DocumentContentInterface[];
    getLinkId(): number;
    getLinkMetadataDocuments(): DocumentContentInterface[];
    getLocalXForm(): Matrix4;
    getParentInstanceId(): number;
    getPartId(): number;
    getPartMetadataDocuments(): DocumentContentInterface[];
    getStatusFlags(): number;
    getStringLinkId(): string;
    getStringPartId(): string;
    getSubLeafMax(): number;
    getSubLeafMin(): number;
    isDisplayable(): boolean;
    isInstanceLeaf(): boolean;
}

Hierarchy (view full)

Methods

getAnnotationGroups getAttachedDocumentInfos getClassId getCumulatedXForm getInstanceDepth getInstanceId getInstanceSecurityTags getInstancesMetadataDocuments getLinkId getLinkMetadataDocuments getLocalXForm getParentInstanceId getPartId getPartMetadataDocuments getStatusFlags getStringLinkId getStringPartId getSubLeafMax getSubLeafMin isDisplayable isInstanceLeaf

Methods

getAnnotationGroups

getAttachedDocumentInfos

getClassId

getCumulatedXForm

  • getCumulatedXForm(): Matrix4

  • Gets the world transformation of this part instance.

    The Matrix4 follows the column multiplication convention (see Matrix4).

    Returns Matrix4

    const
    The Matrix4 of this part instance.

    See

    Matrix4

getInstanceDepth

  • getInstanceDepth(): number

  • Gets the depth of the instance, i.e. the number of parents this part instance has.

    The root instance has a depth of 0.

    Returns number

    The instance depth.

getInstanceId

getInstanceSecurityTags

  • getInstanceSecurityTags(): string[]

  • Gets the security tags of this instance.

    Please refer to DataSessionInterface for an explanation of the tag system.

    DO NOT modify in place this array, this results in undefined behavior.

    Returns string[]

    const
    The security tags of this `part instance`.

getInstancesMetadataDocuments

getLinkId

getLinkMetadataDocuments

  • getLinkMetadataDocuments(): DocumentContentInterface[]

  • Each child of an instance is linked to its parent with an optional link metadata document.

    This is a list of all the link metadata documents of the given part instance.

    If defined, the link documents are retrieved and included in the definition of the child.

    DO NOT modify in place this array, this results in undefined behavior.

    Returns DocumentContentInterface[]

    const
    The list of link documents attached to this instance.

getLocalXForm

getParentInstanceId

  • getParentInstanceId(): number

  • Gets the parent instance id of this part instance.

    A parent instance id of 0 means the part instance is the root part instance.

    Returns number

    The parent instance id of this part instance.

getPartId

getPartMetadataDocuments

  • getPartMetadataDocuments(): DocumentContentInterface[]

  • A part metadata document is shared among all part instances of the same part.

    This is a list of all the part metadata documents of the given part instance.

    A part is the definition of a single element of the DMU that may be instantiated multiple times.

    DO NOT modify in place this array, this results in undefined behavior.

    Returns DocumentContentInterface[]

    const
    The list of part documents attached to this instance.

getStatusFlags

getStringLinkId

getStringPartId

getSubLeafMax

  • getSubLeafMax(): number

  • Gets the maximum sub leaf part instance id.

    This instance id is represented by the given part instance leaves : [getSubLeafMin(), getSubLeafMax()].

    Returns number

    The maximum part instance leaf id.

getSubLeafMin

  • getSubLeafMin(): number

  • Gets the minimum sub leaf part instance id.

    This instance id is represented by the given part instance leaves : [getSubLeafMin(), getSubLeafMax()].

    Returns number

    The minimum part instance leaf id.

isDisplayable

  • isDisplayable(): boolean

  • Tells if this instance is displayable.

    Returns boolean

    true if this instance is displayable, i.e. it is represented by some geometry(ies).

isInstanceLeaf

  • isInstanceLeaf(): boolean

  • Tells if this part instance is a leaf, which means it has no child.

    Returns boolean

    true if the part instance this object refers to is a leaf.

Settings

Member Visibility

Theme

On This Page

getAnnotationGroupsgetAttachedDocumentInfosgetClassIdgetCumulatedXFormgetInstanceDepthgetInstanceIdgetInstanceSecurityTagsgetInstancesMetadataDocumentsgetLinkIdgetLinkMetadataDocumentsgetLocalXFormgetParentInstanceIdgetPartIdgetPartMetadataDocumentsgetStatusFlagsgetStringLinkIdgetStringPartIdgetSubLeafMaxgetSubLeafMinisDisplayableisInstanceLeaf