Representation of a Navigator view item.
typedef struct { API_Box zoom; char modelViewOptName[API_LongNameLen]; API_ModelViewOptions *modelViewOpt; API_StructureDisplay structureDisplay; char layerCombination[API_AttrNameLen]; API_LayerStat **layerStats; Int32 drawingScale; char dimName[API_LongNameLen]; API_DimensionPrefs *dimPrefs; bool saveZoom; bool saveDispOpt; bool saveLaySet; bool saveDScale; bool saveDim; bool savePenSet; bool saveStructureDisplay; bool filler_2[5]; char penSetName[API_AttrNameLen]; API_PenType *pens; bool ignoreSavedZoom; bool filler_3[7]; API_Tranmat tr; API_Guid renovationFilterGuid; GS::uchar_t overrideCombination[API_UniLongNameLen]; GS::uchar_t d3styleName[API_UniLongNameLen]; GS::uchar_t renderingSceneName[API_UniLongNameLen]; bool usePhotoRendering; } API_NavigatorView;
Members
- zoom
- The associated zoom box defined in model coordinates. Valid only if the
saveZoom
field istrue
. - modelViewOptName
- Name of the view’s Model View option [display option in old terminology]. Valid only if the
saveDispOpt
field istrue
. - modelViewOpt
- Model View option stored for this view, if custom. Valid only if the
saveDispOpt
field istrue
. Do not forget to free this pointer if not needed any more. - structureDisplay
- The Partial Structure Display state of the view. See API_StructureDisplay.
- layerCombination
- Layer combination name of the view. Valid only if the
saveLaySet
field istrue
.
The length of this field has been raised up to 256 characters. - layerStats
- Handle to a set of layer status stored for the view. Valid only if the
saveLaySet
field istrue
andlayerCombination
is empty, otherwise it should be set tonullptr
.
Do not forget to dispose this handle if not needed any more. - drawingScale
- The drawing scale associated with the view. Valid only if the
saveDScale
field istrue
. - dimName
- Dimension style attribute name. Valid only if the
saveDim
field istrue
. - dimPrefs
- Dimensioning settings stored for this view (only if custom). Valid only if the
saveDim
field istrue
. Do not forget to free this pointer if not needed any more. - saveZoom
- Zoom box is stored in the view. If
false
, thezoom
field does not contain valid data. - saveDispOpt
- Display options are stored in the view. If
false
, thedisplayOpt
field does not contain valid data. - saveLaySet
- Layer settings are stored in the view. If
false
, thelayerCombination
and the layerStats fields do not contain valid data. - saveDScale
- Drawing scale is stored in the view. If
false
, thedrawingScale
field does not contain valid data. - saveDim
- Dimensioning is stored in this view. If
false
, thedimName
and the dimPrefs fields do not contain valid data. - savePenSet
- Store the penset.
- saveStructureDisplay
- Partial Structure Display setting is stored in the view.
- penSetName[API_AttrNameLen]
- Penset name (empty if custom).
- pens
- Pens of the pen table (only if custom).
- ignoreSavedZoom
- If this value is true, the saved zoomBox for the view is not used when changing between views. (in View Organizer this can be set with the “Do not apply saved zooms when changing views” check)
- renovationFilterGuid
- Renovation filter used by this navigator view.
- overrideCombination
- The currently active override combination in this navigator view (or empty string if there is no active override combination).
- d3styleName
- 3D style name (or empty string if this is not a 3D view).
- renderingSceneName
- Rendering scene name (or empty string if this is not a rendered view).
- usePhotoRendering
- Use photorendering in visualization (for rendered views).
Remarks
You can retrieve information about a view via APINavigator_GetNavigatorViewID and you are able to change it with APINavigator_ChangeNavigatorViewID function.
Requirements
- Version: API 4.3 or later
- Header: APIdefs_Navigator.h