Drawing Clip Frame

Types

	A3DDrawingClipFrameData
	A3DEDrawingClipFrameType

Fields

	kA3DDrawingClipFrameTypeNone
	kA3DDrawingClipFrameTypeRectangular
	kA3DDrawingClipFrameTypeUserDefine

Functions

A3DStatus	A3DDrawingClipFrameGet
A3DStatus	A3DDrawingClipFrameCreate

Detailed Description

group a3d_drawing_clipframe

Define a clipping frame for views.

Entity type is kA3DTypeDrawingClipFrame.

Version

5.0

Type Documentation

enum A3DEDrawingClipFrameType

A3DEDrawingClipFrameType enum.

Version

5.0

Values:

enumerator kA3DDrawingClipFrameTypeNone

Unknown value.

enumerator kA3DDrawingClipFrameTypeRectangular

The frame is a rectangle.

enumerator kA3DDrawingClipFrameTypeUserDefine

The frame is defined by user.

Function Documentation

A3DStatus A3DDrawingClipFrameGet(const A3DDrawingClipFrame *pDrwClipFrame, A3DDrawingClipFrameData *pData)

Populates the A3DDrawingClipFrameData structure.

Version

5.0

Parameters:

• pDrwClipFrame – [in] The input clipping frame.

• pData – [out] Data of the clipping frame.

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 A3DDrawingClipFrameCreate(const A3DDrawingClipFrameData *pData, A3DDrawingClipFrame **ppDrwClipFrame)

Creates an A3DDrawingClipFrame from A3DDrawingClipFrameData structure.

Version

5.0

Parameters:

• pData – [in] The input clipping frame data

• ppDrwClipFrame – [out] The clipping frame entity.

Return values:

• A3D_INITIALIZE_NOT_CALLED –

• A3D_INVALID_DATA_STRUCT_NULL –

• A3D_INVALID_DATA_STRUCT_SIZE –

• A3D_INVALID_ENTITY_TYPE –

• A3D_ERROR –

• A3D_SUCCESS –

Returns:

A3D_SUCCESS in case of success or an error code