CFx SDK Documentation  2023 SP0
Enumerations
OdGiVisualStyleProperties Namespace Reference

Enumerations

enum  Property {
  kInvalidProperty = -1 , kFaceLightingModel = 0 , kFaceLightingQuality = 1 , kFaceColorMode = 2 ,
  kFaceModifiers = 3 , kFaceOpacity = 4 , kFaceSpecular = 5 , kFaceMonoColor = 6 ,
  kEdgeModel = 7 , kEdgeStyles = 8 , kEdgeIntersectionColor = 9 , kEdgeObscuredColor = 10 ,
  kEdgeObscuredLinePattern = 11 , kEdgeIntersectionLinePattern = 12 , kEdgeCreaseAngle = 13 , kEdgeModifiers = 14 ,
  kEdgeColor = 15 , kEdgeOpacity = 16 , kEdgeWidth = 17 , kEdgeOverhang = 18 ,
  kEdgeJitterAmount = 19 , kEdgeSilhouetteColor = 20 , kEdgeSilhouetteWidth = 21 , kEdgeHaloGap = 22 ,
  kEdgeIsolines = 23 , kEdgeHidePrecision = 24 , kDisplayStyles = 25 , kDisplayBrightness = 26 ,
  kDisplayShadowType = 27 , kUseDrawOrder = 28 , kViewportTransparency = 29 , kLightingEnabled = 30 ,
  kPosterizeEffect = 31 , kMonoEffect = 32 , kBlurEffect = 33 , kPencilEffect = 34 ,
  kBloomEffect = 35 , kPastelEffect = 36 , kBlurAmount = 37 , kPencilAngle = 38 ,
  kPencilScale = 39 , kPencilPattern = 40 , kPencilColor = 41 , kBloomThreshold = 42 ,
  kBloomRadius = 43 , kTintColor = 44 , kFaceAdjustment = 45 , kPostContrast = 46 ,
  kPostBrightness = 47 , kPostPower = 48 , kTintEffect = 49 , kBloomIntensity = 50 ,
  kColor = 51 , kTransparency = 52 , kEdgeWiggleAmount = 53 , kEdgeTexturePath = 54 ,
  kDepthOfField = 55 , kFocusDistance = 56 , kFocusWidth = 57 , kPropertyCount
}
 
enum  FaceLightingModel {
  kInvisible = 0 , kConstant = 1 , kPhong = 2 , kGooch = 3 ,
  kZebra = 4
}
 
enum  FaceLightingQuality { kNoLighting = 0 , kPerFaceLighting = 1 , kPerVertexLighting = 2 , kPerPixelLighting = 3 }
 
enum  FaceColorMode {
  kNoColorMode = 0 , kObjectColor = 1 , kBackgroundColor = 2 , kMono = 3 ,
  kTint = 4 , kDesaturate = 5
}
 
enum  FaceModifiers { kNoFaceModifiers = 0 , kFaceOpacityFlag = 1 , kSpecularFlag = 2 }
 
enum  EdgeModel { kNoEdges = 0 , kIsolines = 1 , kFacetEdges = 2 }
 
enum  EdgeStyles {
  kNoEdgeStyle = 0 , kVisibleFlag = 1 , kSilhouetteFlag = 2 , kObscuredFlag = 4 ,
  kIntersectionFlag = 8
}
 
enum  EdgeModifiers {
  kNoEdgeModifiers = 0 , kEdgeOverhangFlag = 1 , kEdgeJitterFlag = 2 , kEdgeWidthFlag = 4 ,
  kEdgeColorFlag = 8 , kEdgeHaloGapFlag = 16 , kAlwaysOnTopFlag = 64 , kEdgeOpacityFlag = 128 ,
  kEdgeWiggleFlag = 256 , kEdgeTextureFlag = 512
}
 
enum  EdgeJitterAmount { kJitterLow = 1 , kJitterMedium = 2 , kJitterHigh = 3 }
 
enum  EdgeWiggleAmount { kWiggleLow = 1 , kWiggleMedium = 2 , kWiggleHigh = 3 }
 
enum  EdgeLinePattern {
  kSolid = 1 , kDashedLine = 2 , kDotted = 3 , kShortDash = 4 ,
  kMediumDash = 5 , kLongDash = 6 , kDoubleShortDash = 7 , kDoubleMediumDash = 8 ,
  kDoubleLongDash = 9 , kMediumLongDash = 10 , kSparseDot = 11
}
 
enum  DisplayStyles {
  kNoDisplayStyle = 0 , kBackgroundsFlag = 1 , kLightingFlag = 2 , kMaterialsFlag = 4 ,
  kTexturesFlag = 8
}
 
enum  DisplayShadowType { kShadowsNone = 0 , kShadowsGroundPlane = 1 , kShadowsFull = 2 , kShadowsFullAndGround = 3 }
 

Detailed Description

Namespace contains visual style property related enumerations. <group TD_Namespaces>

Enumeration Type Documentation

◆ DisplayShadowType

Defines shadow types that can be displayed.

Enumerator
kShadowsNone 
kShadowsGroundPlane 
kShadowsFull 
kShadowsFullAndGround 

Definition at line 963 of file GiVisualStyle.h.

◆ DisplayStyles

Defines a combination of display settings that can be enabled.

Enumerator
kNoDisplayStyle 
kBackgroundsFlag 
kLightingFlag 
kMaterialsFlag 
kTexturesFlag 

Definition at line 951 of file GiVisualStyle.h.

◆ EdgeJitterAmount

Defines a collection of jitter values that can be applied to edges.

Enumerator
kJitterLow 
kJitterMedium 
kJitterHigh 

Definition at line 910 of file GiVisualStyle.h.

◆ EdgeLinePattern

Defines a collection of line patterns that can be applied to edges.

Enumerator
kSolid 
kDashedLine 
kDotted 
kShortDash 
kMediumDash 
kLongDash 
kDoubleShortDash 
kDoubleMediumDash 
kDoubleLongDash 
kMediumLongDash 
kSparseDot 

Definition at line 930 of file GiVisualStyle.h.

◆ EdgeModel

Defines the model that is used to display the edges.

Enumerator
kNoEdges 
kIsolines 
kFacetEdges 

Definition at line 870 of file GiVisualStyle.h.

◆ EdgeModifiers

Defines a collection of modifiers that can be applied to edges to give them various types of effects.

Enumerator
kNoEdgeModifiers 
kEdgeOverhangFlag 
kEdgeJitterFlag 
kEdgeWidthFlag 
kEdgeColorFlag 
kEdgeHaloGapFlag 
kAlwaysOnTopFlag 
kEdgeOpacityFlag 
kEdgeWiggleFlag 
kEdgeTextureFlag 

Definition at line 892 of file GiVisualStyle.h.

◆ EdgeStyles

Defines a collection of bitflags that represent the combination of edge styles to display.

Enumerator
kNoEdgeStyle 
kVisibleFlag 
kSilhouetteFlag 
kObscuredFlag 
kIntersectionFlag 

Definition at line 880 of file GiVisualStyle.h.

◆ EdgeWiggleAmount

Defines a collection of wiggle values that can be applied to edges.

Enumerator
kWiggleLow 
kWiggleMedium 
kWiggleHigh 

Definition at line 920 of file GiVisualStyle.h.

◆ FaceColorMode

Defines modifications that affect the color of a face before any lighting and shading calculations have been performed.

Enumerator
kNoColorMode 
kObjectColor 
kBackgroundColor 
kMono 
kTint 
kDesaturate 

Definition at line 842 of file GiVisualStyle.h.

◆ FaceLightingModel

Defines the lighting model to apply to the faces of drawables.

Enumerator
kInvisible 
kConstant 
kPhong 
kGooch 
kZebra 

Definition at line 817 of file GiVisualStyle.h.

◆ FaceLightingQuality

Defines the calculation method of lighting effects to apply to faces.

Enumerator
kNoLighting 
kPerFaceLighting 
kPerVertexLighting 
kPerPixelLighting 

Definition at line 830 of file GiVisualStyle.h.

◆ FaceModifiers

Bitfield that describes modifications to faces made before any lighting and shading calculations have been performed.

Enumerator
kNoFaceModifiers 
kFaceOpacityFlag 
kSpecularFlag 

Definition at line 856 of file GiVisualStyle.h.

◆ Property

Defines the get/set properties for a visual style.

Enumerator
kInvalidProperty 
kFaceLightingModel 
kFaceLightingQuality 
kFaceColorMode 
kFaceModifiers 
kFaceOpacity 
kFaceSpecular 
kFaceMonoColor 
kEdgeModel 
kEdgeStyles 
kEdgeIntersectionColor 
kEdgeObscuredColor 
kEdgeObscuredLinePattern 
kEdgeIntersectionLinePattern 
kEdgeCreaseAngle 
kEdgeModifiers 
kEdgeColor 
kEdgeOpacity 
kEdgeWidth 
kEdgeOverhang 
kEdgeJitterAmount 
kEdgeSilhouetteColor 
kEdgeSilhouetteWidth 
kEdgeHaloGap 
kEdgeIsolines 
kEdgeHidePrecision 
kDisplayStyles 
kDisplayBrightness 
kDisplayShadowType 
kUseDrawOrder 
kViewportTransparency 
kLightingEnabled 
kPosterizeEffect 
kMonoEffect 
kBlurEffect 
kPencilEffect 
kBloomEffect 
kPastelEffect 
kBlurAmount 
kPencilAngle 
kPencilScale 
kPencilPattern 
kPencilColor 
kBloomThreshold 
kBloomRadius 
kTintColor 
kFaceAdjustment 
kPostContrast 
kPostBrightness 
kPostPower 
kTintEffect 
kBloomIntensity 
kColor 
kTransparency 
kEdgeWiggleAmount 
kEdgeTexturePath 
kDepthOfField 
kFocusDistance 
kFocusWidth 
kPropertyCount 

Definition at line 733 of file GiVisualStyle.h.