Entity Reference

Creates and accesses references to other PRC entities.

2.0

Entity type is:c:enumerator:~kA3DTypeMiscEntityReference.

An:c:type:~A3DMiscEntityReferencereferences an entity containing structure data, representation items, topology data, markup data or scene display data. All of these entities can be referenced from other entities. For example, the:c:type:~A3DAsmProductOccurrenceentity (Product Occurrence) can include an:c:type:~A3DMiscEntityReferenceentity that references another product occurrence. In another example, an:c:type:~A3DAsmFilterentity (Filter Module) can include an entity filter for which multiple:c:type:~A3DMiscEntityReferenceentities specify the entities to be inclusively or exclusively filtered.

The:c:type:~A3DMiscEntityReferencecan supply modifiers that affect the referenced entity nominal definition. All entity references can include a coordinate system, which is applied to the referenced item. Topology entity references can also include global index items, such as color and texture.

To create references for non-topological entities listed in:ref:Referenceable Non-Topological Entities <group__a3d__eligibleforreference>, perform these steps:

  1. Create an:c:struct:~A3DMiscEntityReferenceDatastructure that references the non-topological entity.
  2. Set the coordinate system transformation in the:c:struct:~A3DMiscEntityReferenceDatastructure as needed.
  3. Create an:c:type:~A3DMiscEntityReferencethat references the:c:struct:~A3DMiscEntityReferenceDatastructure.

To create references for topological entities listed in:ref:Referenceable Topological Entities <group__a3d__eligiblefortopologicalreference>, perform these steps:

  1. Create an:c:struct:~A3DMiscReferenceOnTopologyDatastructure that references the topological entity.
  2. Set global index items in the:c:struct:~A3DMiscReferenceOnTopologyDatastructure as needed.
  3. Create an:c:type:~A3DMiscReferenceOnTopologyentity, providing the:c:struct:~A3DMiscReferenceOnTopologyDatastructure.
  4. Create an:c:struct:~A3DMiscEntityReferenceDatastructure that references the:c:type:~A3DMiscReferenceOnTopologyentity.
  5. Set the coordinate system transformation in the:c:struct:~A3DMiscEntityReferenceDatastructure as needed.
  6. Create an:c:type:~A3DMiscEntityReferencethat references the:c:struct:~A3DMiscEntityReferenceDatastructure.

See the referenceable types in the modules:ref:Referenceable Non-Topological Entities <group__a3d__eligibleforreference>and:ref:Referenceable Topological Entities <group__a3d__eligiblefortopologicalreference>.

Returns

A3D_SUCCESSon success, or an error code on failure

Topics

Structures

Functions