Define a clipping frame for views. More...

Data Structures

struct  A3DDrawingClipFrameData
 A3DDrawingClipFrame structure. More...
 

Enumerations

enum  A3DEDrawingClipFrameType {
  kA3DDrawingClipFrameTypeNone = 0,
  kA3DDrawingClipFrameTypeRectangular = 1,
  kA3DDrawingClipFrameTypeUserDefine = 2
}
 A3DEDrawingClipFrameType enum. More...
 

Functions

A3DStatus A3DDrawingClipFrameCreate (const A3DDrawingClipFrameData *pData, A3DDrawingClipFrame **ppDrwClipFrame)
 Creates an A3DDrawingClipFrame from A3DDrawingClipFrameData structure. More...
 
A3DStatus A3DDrawingClipFrameGet (const A3DDrawingClipFrame *pDrwClipFrame, A3DDrawingClipFrameData *pData)
 Populates the A3DDrawingClipFrameData structure. More...
 

Detailed Description

Define a clipping frame for views.

Version
5.0

Entity type is kA3DTypeDrawingClipFrame.

Enumeration Type Documentation

◆ A3DEDrawingClipFrameType

A3DEDrawingClipFrameType enum.

Version
5.0
drawing_view_clipping_type.png
Enumerator
kA3DDrawingClipFrameTypeNone 

Unknown value.

kA3DDrawingClipFrameTypeRectangular 

The frame is a rectangle.

kA3DDrawingClipFrameTypeUserDefine 

The frame is defined by user.

Function Documentation

◆ A3DDrawingClipFrameGet()

A3DStatus A3DDrawingClipFrameGet ( const A3DDrawingClipFrame pDrwClipFrame,
A3DDrawingClipFrameData pData 
)

Populates the A3DDrawingClipFrameData structure.

Version
5.0
Parameters
[in]pDrwClipFrameThe input clipping frame.
[out]pDataData of the clipping frame.
Returns
A3D_SUCCESS in case of success or an error code
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

◆ A3DDrawingClipFrameCreate()

A3DStatus A3DDrawingClipFrameCreate ( const A3DDrawingClipFrameData pData,
A3DDrawingClipFrame **  ppDrwClipFrame 
)

Creates an A3DDrawingClipFrame from A3DDrawingClipFrameData structure.

Version
5.0
Parameters
[in]pDataThe input clipping frame data
[out]ppDrwClipFrameThe clipping frame entity.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INITIALIZE_NOT_CALLED
A3D_INVALID_DATA_STRUCT_NULL
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_ENTITY_TYPE
A3D_ERROR
A3D_SUCCESS