Entity Reference

Detailed Description

group a3d_entity_reference

Creates and accesses references to other PRC entities.

Entity type is kA3DTypeMiscEntityReference.

Version

2.0

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

The A3DMiscEntityReference can 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 A3DMiscEntityReferenceData structure that references the non-topological entity.

  2. Set the coordinate system transformation in the A3DMiscEntityReferenceData structure as needed.

  3. Create an A3DMiscEntityReference that references the A3DMiscEntityReferenceData structure.

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

  1. Create an A3DMiscReferenceOnTopologyData structure that references the topological entity.

  2. Set global index items in the A3DMiscReferenceOnTopologyData structure as needed.

  3. Create an A3DMiscReferenceOnTopology entity, providing the A3DMiscReferenceOnTopologyData structure.

  4. Create an A3DMiscEntityReferenceData structure that references the A3DMiscReferenceOnTopology entity.

  5. Set the coordinate system transformation in the A3DMiscEntityReferenceData structure as needed.

  6. Create an A3DMiscEntityReference that references the A3DMiscEntityReferenceData structure.

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

Function Documentation

A3DStatus A3DMiscEntityReferenceGet(const A3DMiscEntityReference *pEntityReference, A3DMiscEntityReferenceData *pData)

Populates the A3DMiscEntityReferenceData structure.

Version

2.0

Return values

  • A3D_INITIALIZE_NOT_CALLED –

  • A3D_INVALID_DATA_STRUCT_SIZE –

  • A3D_INVALID_DATA_STRUCT_NULL –

  • A3D_INVALID_ENTITY_NULL –

  • A3D_INVALID_ENTITY_TYPE –

  • A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DMiscEntityReferenceCreate(const A3DMiscEntityReferenceData *pData, A3DMiscEntityReference **ppEntityReference)

Creates an A3DMiscEntityReference from an A3DMiscEntityReferenceData structure.

Version

2.0

Return values

  • A3D_INVALID_DATA_STRUCT_SIZE –

  • A3D_INVALID_DATA_STRUCT_NULL –

  • A3D_ENTITYREFERENCE_INCONSISTENT_REFERENCE –

  • A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DMiscEntityReferenceSet(A3DMiscEntityReference *pEntityReference, const A3DMiscEntityReferenceData *pData)

Function to set the entity reference from A3DMiscEntityReferenceData structure in a previously created object.

Version

2.0

Return values

  • A3D_INVALID_DATA_STRUCT_SIZE –

  • A3D_INVALID_DATA_STRUCT_NULL –

  • A3D_ENTITYREFERENCE_INCONSISTENT_REFERENCE –

  • A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code