Entity Reference

Creates and accesses references to other PRC entities.

2.0

Entity type is kA3DTypeMiscEntityReference.

An 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 A3DAsmProductOccurrenceentity (Product Occurrence) can include an A3DMiscEntityReferenceentity that references another product occurrence. In another example, an A3DAsmFilterentity (Filter Module) can include an entity filter for which multiple A3DMiscEntityReferenceentities specify the entities to be inclusively or exclusively filtered.

The 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 Referenceable Non-Topological Entities, perform these steps:

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

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

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

See the referenceable types in the modules Referenceable Non-Topological Entitiesand Referenceable Topological Entities.

Returns

A3D_SUCCESSon success, or an error code on failure

Topics

Structures

Functions