#include <sc_store.h>

Public Types

enum  Bits : uint32_t {
  None = 0x00000000, DoNotCut = 0x00000001, DoNotCap = 0x00000002, AlwaysDraw = 0x00000004,
  ScreenOriented = 0x00000008, SuppressCameraScale = 0x00000010, DoNotExplode = 0x00000020, DoNotSelect = 0x00000040,
  ScreenSpace = 0x00000100, ScreenSpaceStretched = 0x00000200, OutlineClipRegion = 0x00000400, DoNotLight = 0x00000800,
  OverrideSceneVisibility = 0x00001000, DoNotOutlineHighlight = 0x00002000, ExcludeBounding = 0x00004000, DoNotUseVertexColors = 0x00008000,
  AlwaysStream = 0x00010000, Default = (None)
}
 

Public Member Functions

 Modifiers ()
 
 Modifiers (uint32_t value)
 
 operator uint32_t () const
 
Modifiersoperator= (uint32_t value)
 
bool operator== (Modifiers const &that)
 

Public Attributes

uint32_t _value
 

Detailed Description

The Modifiers class holds Bits used to define instance modifiers.

Member Enumeration Documentation

◆ Bits

enum SC::Store::Modifiers::Bits : uint32_t

An enumeration of bit flags that modify the drawing of an instance.

Enumerator
None 
DoNotCut 

If set, the instance will not be affected by cutting planes.

DoNotCap 

If set, the instance will not generate capping geometry.

AlwaysDraw 

If set, the instance will be drawn before other instances and will not be culled in order to reach the target frame rate.

ScreenOriented 

If set, the instance will be oriented such that the cardinal axes of object space are aligned with the cardinal axes of screen space.

SuppressCameraScale 

If set, the instance will be drawn at the same size regardless of camera settings.

DoNotExplode 

If set, the instance will not be affected by an explode operation.

DoNotSelect 

If set, the instance will not be selectable.

ScreenSpace 

If set, the instance will be drawn in a space that extends from X=-1 at the left side of the screen to X=1 at the right side of the screen and from Y=-1 at the bottom of the screen to Y=1 at the top of the screen.

If the aspect ratio of the screen is not 1:1, the instance will be scaled so that it appears as if the aspect ratio were 1:1 (i.e., so that the instance will not appear stretched).

ScreenSpaceStretched 

If set, the instance will be drawn in a space that extends from X=-1 at the left side of the screen to X=1 at the right side of the screen and from Y=-1 at the bottom of the screen to Y=1 at the top of the screen.

If the aspect ratio of the screen is not 1:1, the instance will stretch in the direction of the longer side.

OutlineClipRegion 

If set, the instance clip region will be outlined in the viewer

DoNotLight 

If set, the instance will not be lit.

OverrideSceneVisibility 

If set, the instance will ignore scene-level visibility.

DoNotOutlineHighlight 

If set, the instance will not be outlined when highlighted.

ExcludeBounding 

If set, the instance will not be included in bounding calculations.

DoNotUseVertexColors 

If set, the instance will not use the mesh's per-vertex colors.

AlwaysStream 

If set, the instance will be streamed first and not unloaded by memory limiting.

Default 

Constructor & Destructor Documentation

◆ Modifiers() [1/2]

SC::Store::Modifiers::Modifiers ( )

◆ Modifiers() [2/2]

SC::Store::Modifiers::Modifiers ( uint32_t  value)
explicit

Member Function Documentation

◆ operator uint32_t()

SC::Store::Modifiers::operator uint32_t ( ) const

◆ operator=()

Modifiers& SC::Store::Modifiers::operator= ( uint32_t  value)

◆ operator==()

bool SC::Store::Modifiers::operator== ( Modifiers const &  that)

Member Data Documentation

◆ _value

uint32_t SC::Store::Modifiers::_value