The entity reference of an object of a twin loaded through TwinClient: twin~twin:<twinId> for
the model's project, and twin~twin:<twinId>.entity:<gid> for one of its products.
The object knows its twin because the client recorded it when the model was loaded, by any
loadTwin… call on any TwinClient. Several twins, and several loads of one twin, can be held at
once: each object names the twin it was loaded for, and every load of one twin gives the same
entity references. The twin's version is not part of the entity reference.
Returns undefined when:
object was not loaded as the project or a product of a twin by TwinClient. That includes an
entity type, a model read without the client, and a product added to model.products after the
load.
The product's gid is empty or not a canonical IFC GlobalId. This occurs for DWG-derived objects,
and for twins stored before specification entity ids were required to be IFC GlobalIds.
The twin id is not a lowercase uuid. This happens when the twin was loaded with an uppercase
id, because the id is used as passed to the loader.
Makes no request. A caller holding ids rather than a loaded object uses the builders, such as
entityReferenceOfTwinEntity.
Parameters
object: object
The project or a product of a loaded twin's model.
The entity reference of an object of a twin loaded through
TwinClient:twin~twin:<twinId>for the model's project, andtwin~twin:<twinId>.entity:<gid>for one of its products.The object knows its twin because the client recorded it when the model was loaded, by any
loadTwin…call on anyTwinClient. Several twins, and several loads of one twin, can be held at once: each object names the twin it was loaded for, and every load of one twin gives the same entity references. The twin's version is not part of the entity reference.Returns
undefinedwhen:objectwas not loaded as the project or a product of a twin byTwinClient. That includes an entity type, a model read without the client, and a product added tomodel.productsafter the load.Makes no request. A caller holding ids rather than a loaded object uses the builders, such as entityReferenceOfTwinEntity.