SketchUp SDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Functions
rendering_options.h File Reference
#include <slapi/color.h>
#include <slapi/slapi.h>
#include <slapi/model/defs.h>

Go to the source code of this file.

Functions

SU_RESULT SURenderingOptionsSetValue (SURenderingOptionsRef rendering_options, const char *key, SUTypedValueRef value_in)
 Sets values in a rendering options object. More...
 
SU_RESULT SURenderingOptionsGetValue (SURenderingOptionsRef rendering_options, const char *key, SUTypedValueRef *value_out)
 Retrieves the name of a scene object. More...
 

Function Documentation

SU_RESULT SURenderingOptionsGetValue ( SURenderingOptionsRef  rendering_options,
const char *  key,
SUTypedValueRef value_out 
)

Retrieves the name of a scene object.

Parameters
[in]rendering_optionsThe rendering options object.
[in]keyThe key. Assumed to be UTF-8 encoded.
[out]value_outThe value retrieved.
Returns

The breakdown of rendering options and value types is shown in the table below.

Rendering Option Value Type
BackgroundColor SUTypedValueType_Color
BandColor SUTypedValueType_Color
ConstructionColor SUTypedValueType_Color
DepthQueWidth SUTypedValueType_Int32
DisplayColorByLayer SUTypedValueType_Bool
DisplayDims SUTypedValueType_Bool
DisplayFog SUTypedValueType_Bool
DisplayInstanceAxes SUTypedValueType_Bool
DisplaySketchAxes SUTypedValueType_Bool
DisplayText SUTypedValueType_Bool
DisplayWatermarks SUTypedValueType_Bool
DrawDepthQue SUTypedValueType_Bool
DrawGround SUTypedValueType_Bool
DrawHidden SUTypedValueType_Bool
DrawHorizon SUTypedValueType_Bool
DrawLineEnds SUTypedValueType_Bool
DrawProfilesOnly SUTypedValueType_Bool
DrawSilhouettes SUTypedValueType_Bool
DrawUnderground SUTypedValueType_Bool
EdgeColorMode SUTypedValueType_Int32
EdgeDisplayMode SUTypedValueType_Int32
EdgeType SUTypedValueType_Int32
ExtendLines SUTypedValueType_Bool
FaceBackColor SUTypedValueType_Color
FaceColorMode SUTypedValueType_Int32
FaceFrontColor SUTypedValueType_Color
FogColor SUTypedValueType_Color
FogEndDist SUTypedValueType_Double
FogStartDist SUTypedValueType_Double
FogUseBkColor SUTypedValueType_Bool
ForegroundColor SUTypedValueType_Color
GroundColor SUTypedValueType_Color
GroundTransparency SUTypedValueType_Int32
HideConstructionGeometry SUTypedValueType_Bool
HighlightColor SUTypedValueType_Color
HorizonColor SUTypedValueType_Color
InactiveFade SUTypedValueType_Double
InactiveHidden SUTypedValueType_Bool
InstanceFade SUTypedValueType_Double
InstanceHidden SUTypedValueType_Bool
JitterEdges SUTypedValueType_Bool
LineEndWidth SUTypedValueType_Int32
LineExtension SUTypedValueType_Int32
LockedColor SUTypedValueType_Color
MaterialTransparency SUTypedValueType_Bool
ModelTransparency SUTypedValueType_Bool
RenderMode SUTypedValueType_Int32
SectionActiveColor SUTypedValueType_Color
SectionCutWidth SUTypedValueType_Int32
SectionDefaultCutColor SUTypedValueType_Color
SectionInactiveColor SUTypedValueType_Color
ShowViewName SUTypedValueType_Bool
SilhouetteWidth SUTypedValueType_Int32
SkyColor SUTypedValueType_Color
Texture SUTypedValueType_Bool
TransparencySort SUTypedValueType_Int32

Some of the options map to enumerated values, as shown in the table below.

Option Value Meaning
EdgeColorMode 0: ObjectColor
  1: ForegroundColor
  2: DirectionColor
EdgeDisplayMode 0: EdgeDisplayNone
  1: EdgeDisplayAll
  2: EdgeDisplayStandalone
RenderMode 0: RenderWireframe
  1: RenderHidden
  2: RenderFlat
  3: RenderSmooth
  4: RenderTextureObsolete
  5: RenderNoMaterials
FaceColorMode 0: TwoSided
  1: OneSided
EdgeType 0: EdgeStandard
  1: EdgeNPR
SU_RESULT SURenderingOptionsSetValue ( SURenderingOptionsRef  rendering_options,
const char *  key,
SUTypedValueRef  value_in 
)

Sets values in a rendering options object.

Parameters
[in]rendering_optionsThe rendering options object.
[in]keyThe key. Assumed to be UTF-8 encoded.
[in]value_inThe value used to set the option.
Returns