Public Member Functions | Public Attributes | List of all members
DisplayStyleFlags Struct Reference

This sub-structure describes the 'flags' part of a DisplayStyle. More...

#include <DisplayStyleManager.h>

Public Member Functions

 DisplayStyleFlags ()
 
 ~DisplayStyleFlags ()
 
bool Equals (DisplayStyleFlagsCR rhs) const
 Performs a deep by-value equality check with another instance. More...
 
void SetDisplayMode (MSRenderMode value)
 

Public Attributes

unsigned m_displayMode:6
 The rendering technique; valid values are MSRenderMode::Wireframe, MSRenderMode::HiddenLine, MSRenderMode::SolidFill, or MSRenderMode::SmoothShade. More...
 
unsigned m_displayVisibleEdges:1
 Toggles the display of visible edges. More...
 
unsigned m_displayHiddenEdges:1
 Toggles the display of hidden edges. More...
 
unsigned m_hiddenEdgeLineStyle:3
 Controls the line style of hidden edges; valid values are 0-7 inclusive. More...
 
unsigned m_displayShadows:1
 Toggles the display of shadows. More...
 
unsigned m_legacyDrawOrder:1
 Enables 'legacy draw' (or 'file') order; means z-position is based on file position. More...
 
unsigned m_overrideBackgroundColor:1
 Enables or disables the override of the background color. More...
 
unsigned m_applyEdgeStyleToLines:1
 8.11.7: applies edges style to wires / open elements More...
 
unsigned m_ignoreGeometryMaps:1
 8.11.9 - Ignore geometry maps. More...
 
unsigned m_ignoreImageMaps:1
 8.11.9 - Ignore image (Pattern) maps - shaded only. More...
 
unsigned m_hideInPickers:1
 8.11.9 - Hide in pickers (but remain in display style dialog for editing, and available through API). More...
 
unsigned m_invisibleToCamera:1
 8.11.9 - Make geometry invisible to camera, but still cast shadows and appear in reflections. Luxology only. More...
 
unsigned m_displayGroundPlane:1
 8.11.9 display a ground plane More...
 
unsigned m_unused:12
 

Detailed Description

This sub-structure describes the 'flags' part of a DisplayStyle.

The display-relevant data stored in a display style is separated into several groups. The 'flags' are generally control bits that describe the underlying rendering parameters. Note that not all flags are valid for every display mode.

Note
This structure is not intended to be used directly.

Constructor & Destructor Documentation

Member Function Documentation

bool Equals ( DisplayStyleFlagsCR  rhs) const

Performs a deep by-value equality check with another instance.

void SetDisplayMode ( MSRenderMode  value)

Member Data Documentation

unsigned m_applyEdgeStyleToLines

8.11.7: applies edges style to wires / open elements

unsigned m_displayGroundPlane

8.11.9 display a ground plane

unsigned m_displayHiddenEdges

Toggles the display of hidden edges.

unsigned m_displayMode
unsigned m_displayShadows

Toggles the display of shadows.

unsigned m_displayVisibleEdges

Toggles the display of visible edges.

unsigned m_hiddenEdgeLineStyle

Controls the line style of hidden edges; valid values are 0-7 inclusive.

unsigned m_hideInPickers

8.11.9 - Hide in pickers (but remain in display style dialog for editing, and available through API).

unsigned m_ignoreGeometryMaps

8.11.9 - Ignore geometry maps.

unsigned m_ignoreImageMaps

8.11.9 - Ignore image (Pattern) maps - shaded only.

unsigned m_invisibleToCamera

8.11.9 - Make geometry invisible to camera, but still cast shadows and appear in reflections. Luxology only.

unsigned m_legacyDrawOrder

Enables 'legacy draw' (or 'file') order; means z-position is based on file position.

unsigned m_overrideBackgroundColor

Enables or disables the override of the background color.

unsigned m_unused

The documentation for this struct was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.