Filter Module

Types

A3DAsmLayerFilterItemData

A3DAsmEntityFilterItemData

A3DAsmFilterData

Functions

A3DStatus

A3DAsmFilterGet

A3DStatus

A3DAsmFilterCreate

Detailed Description

group a3d_filter

Creates and accesses filter entities that control the entities and layers included in the 3D image.

Entity type is kA3DTypeAsmFilter.

The filter entity lets you include or exclude product occurrences or representation items based on their layer or entity type. Such inclusive or exclusive filtering applies to the primary entity and its descendants. For example, you can exclude all wireframe entities.

You can filter entities from these perspectives:

  • Layer, inclusively. Only the entities belonging to a certain layer are included in the 3D view. Entities in other layers are removed.

  • Layer, exclusively. Only the entities not belonging to a certain layer are included in the 3D view. Entities in other layers are removed.

  • Entity, inclusively. Only entities of certain types are included in the 3D view. Entities of other types are removed.

  • Entity, exclusively. Only entities not of certain types are included in the 3D view. Entities of other types are removed.

If the A3DAsmLayerFilterItemData::m_bIsInclusive member is TRUE, the layer filter is inclusive; otherwise, it is exclusive. Similarly for an entity filter, if the A3DAsmEntityFilterItemData::m_bIsInclusive member is TRUE, the entity filter is inclusive; otherwise, it is exclusive. If a layer or entity satisfies an inclusive filter criterion, then it and all of its child entities are included in the 3D view. If a layer or entity satisfies an exclusive filter criterion, then it and all its child entities are excluded from the 3D view.

For example, if one of the entries in the A3DAsmLayerFilterItemData::m_puiLayerIndexes member specifies a layer index of “3” and if the A3DAsmLayerFilterItemData::m_bIsInclusive member is FALSE, then entities with miscellaneous cascaded attributes member m_usLayer set to 3 are excluded from the 3D view.

Multiple filters can be specified within a particular Product Occurrence entity. The filters specified within one product are propagated to descendent product occurrences.

Function Documentation

A3DStatus A3DAsmFilterGet(const A3DAsmFilter *pFilter, A3DAsmFilterData *pData)

Populates the A3DAsmFilterData structure with data from an A3DAsmFilter entity.

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 A3DAsmFilterCreate(const A3DAsmFilterData *pData, A3DAsmFilter **ppFilter)

Creates an A3DAsmFilter entity from an A3DAsmFilterData structure.

Version

2.0

Return values

  • A3D_INVALID_DATA_STRUCT_SIZE –

  • A3D_INVALID_DATA_STRUCT_NULL –

  • A3D_PARTDEFINITION_INCONSISTENT_EMPTY –

  • A3D_SUCCESS –

Returns

A3D_SUCCESS in case of success or an error code