Data Structures

struct  A3DMkpViewData
 View structure. More...
 
struct  A3DMkpViewFlagsData
 The set of activated components in a View. More...
 

Functions

A3DStatus A3DMkpViewCreate (const A3DMkpViewData *pData, A3DMkpView **ppView)
 Creates an A3DMkpView from an A3DMkpViewData structure. More...
 
A3DStatus A3DMkpViewGet (const A3DMkpView *pView, A3DMkpViewData *pData)
 Populates the A3DMkpViewData structure. More...
 
A3DStatus A3DMkpViewGetFlags (const A3DMkpView *pView, A3DMkpViewFlagsData *pFlags)
 Returns the set of components for a view using a A3DMkpViewFlagsData. More...
 

Detailed Description

Entity type is kA3DTypeMkpView.

A view is either a grouping of markups or a particular representation of the 3D scene, depending on the value of the A3DMkpViewData::m_bIsAnnotationView member. If A3DMkpViewData::m_bIsAnnotationView is TRUE, the view contains only an array of annotation entities. If it is FALSE, it can also redefine other view properties such scene display parameters, entity visibilities, and positions on representation items and markups

Function Documentation

◆ A3DMkpViewGet()

A3DStatus A3DMkpViewGet ( const A3DMkpView pView,
A3DMkpViewData pData 
)

Populates the A3DMkpViewData structure.

Version
2.0
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

◆ A3DMkpViewCreate()

A3DStatus A3DMkpViewCreate ( const A3DMkpViewData pData,
A3DMkpView **  ppView 
)

Creates an A3DMkpView from an A3DMkpViewData structure.

Version
2.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_SUCCESS

◆ A3DMkpViewGetFlags()

A3DStatus A3DMkpViewGetFlags ( const A3DMkpView pView,
A3DMkpViewFlagsData pFlags 
)

Returns the set of components for a view using a A3DMkpViewFlagsData.

Version
7.1
Parameters
[in]pViewThe view to get components info from.
[out]pFlagsThe set of flags to write in.
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_NULL
A3D_SUCCESS