Miscellaneous Attribute Entity

Types

	A3DMiscSingleAttributeData
	A3DMiscAttributeData
	A3DMiscAttributeBasicUnitData
	A3DMiscAttributeUnitData
	`A3DEModellerAttributeType`

Fields

	`kA3DModellerAttributeTypeNull`
	`kA3DModellerAttributeTypeInt`
	`kA3DModellerAttributeTypeReal`
	`kA3DModellerAttributeTypeTime`
	`kA3DModellerAttributeTypeString`

Functions

`A3DStatus`	`A3DMiscAttributeGet`
`A3DStatus`	`A3DMiscAttributeCreate`
`A3DStatus`	`A3DGlobalGetUnit`
`A3DStatus`	`A3DGlobalGetUnitData`

Detailed Description

group a3d_attribute

Creates and accesses descriptive names and modeller data associated with PRC entities.

Entity type is kA3DTypeMiscAttribute.

Version: 11.1

This structure defines the miscellaneous attributes owned by an A3DRootBase entity.

Type Documentation

enum A3DEModellerAttributeType

A3DSDKRootEntities.

An enumeration that identifies the type of modeller data represented in an A3DMiscSingleAttributeData structure

Values:

enumerator kA3DModellerAttributeTypeNull: Null type; invalid.

enumerator kA3DModellerAttributeTypeInt: 32-bit unsigned Integer (A3DUns32).

enumerator kA3DModellerAttributeTypeReal: 64-bit double precision floating point value (A3DDouble).

enumerator kA3DModellerAttributeTypeTime: 32-bit unsigned Integer, interpreted as time_t.

enumerator kA3DModellerAttributeTypeString: UTF-8 character c-string (A3DUTF8Char).

Function Documentation

A3DStatus A3DMiscAttributeGet(const A3DMiscAttribute *pAttribute, A3DMiscAttributeData *pData)

Populates the A3DMiscAttributeData 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 on success, or an error code on failure

A3DStatus A3DMiscAttributeCreate(const A3DMiscAttributeData *pData, A3DMiscAttribute **ppAttribute)

Creates an A3DMiscAttribute from A3DMiscAttributeData structure.

Version: 2.0

Return values:

A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_SUCCESS –

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DGlobalGetUnit(const A3DUns32 uiIndexUnit, A3DMiscAttributeUnit **ppUnit)

Get unit information related to a A3DMiscSingleAttributeData structure.

Version: 12.1

Return values:

A3D_INVALID_UNIT_INDEX –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_SUCCESS –

Returns:

A3D_SUCCESS on success, or an error code on failure

A3DStatus A3DGlobalGetUnitData(A3DMiscAttributeUnit *const pUnit, A3DMiscAttributeUnitData *pData)

Get unit information related to a A3DMiscSingleAttributeData structure.

Version: 12.1

Return values:

A3D_INVALID_UNIT_INDEX –
A3D_INVALID_DATA_STRUCT_SIZE –
A3D_INVALID_DATA_STRUCT_NULL –
A3D_SUCCESS –

Returns:

A3D_SUCCESS on success, or an error code on failure