Go to Google Code Home
Google SketchUp SkpWriter C++ API Documentation (Labs)

Public Member Functions

atlast::sketchup::ISketchUpOptionsManager Class Reference

A collection of OptionProviders. More...

#include <ioptionsmanager.h>

Inheritance diagram for atlast::sketchup::ISketchUpOptionsManager:
atlast::sketchup::ISketchUpEntity atlast::sketchup::ISketchUpObject

List of all members.

Public Member Functions

virtual unsigned int GetOptionProviderCount () const =0
 Retrieves the number of ISketchUpOptionsProvider objects managed by this object.
virtual ISketchUpOptionsProviderPtr GetOptionsProvider (unsigned int indx) const =0
 Returns the i'th ISketchUpOptionProvider.
virtual ISketchUpOptionsProviderPtr GetOptionsProvider (LPCWSTR providerName) const =0
 Gets the option provider of the given name.

Detailed Description

A collection of OptionProviders.

For a typical model we might find:

- <Options>
- <OptionsProvider name="PageOptions">
<Option name="ShowTransition" value="true" /> 
<Option name="TransitionTime" value="1.5" /> 
</OptionsProvider>
- <OptionsProvider name="AxisOptions">
<Option name="DisplayAxes" value="true" /> 
</OptionsProvider>
- <OptionsProvider name="SlideshowOptions">
<Option name="LoopSlideshow" value="true" /> 
<Option name="SlideTime" value="1" /> 
</OptionsProvider>
- <OptionsProvider name="UnitsOptions">
<Option name="LengthPrecision" value="4" /> 
<Option name="LengthFormat" value="1" /> 
<Option name="LengthUnit" value="0" /> 
<Option name="LengthSnapEnabled" value="true" /> 
<Option name="LengthSnapLength" value="0.25" /> 
<Option name="AnglePrecision" value="1" /> 
<Option name="AngleSnapEnabled" value="true" /> 
<Option name="SnapAngle" value="15" /> 
<Option name="SuppressUnitsDisplay" value="false" /> 
<Option name="ForceInchDisplay" value="false" /> 
</OptionsProvider>
- <OptionsProvider name="RenderingOptions">
<Option name="BackgroundColor" value="unknown type" /> 
<Option name="BandColor" value="unknown type" /> 
<Option name="ConstructionColor" value="unknown type" /> 
<Option name="DepthQueWidth" value="4" /> 
<Option name="DisplayColorByLayer" value="false" /> 
<Option name="DisplayFog" value="false" /> 
<Option name="DisplayFogEdges" value="false" /> 
<Option name="DisplayInstanceAxes" value="false" /> 
<Option name="DrawDepthQue" value="false" /> 
<Option name="DrawGround" value="false" /> 
<Option name="DrawHidden" value="false" /> 
<Option name="DrawHorizon" value="false" /> 
<Option name="DrawLineEnds" value="false" /> 
<Option name="DrawProfilesOnly" value="false" /> 
<Option name="DrawSilhouettes" value="true" /> 
<Option name="DrawUnderground" value="true" /> 
<Option name="EdgeColorMode" value="1" /> 
<Option name="EdgeDisplayMode" value="1" /> 
<Option name="ExtendLines" value="false" /> 
<Option name="FaceBackColor" value="unknown type" /> 
<Option name="FaceColorMode" value="0" /> 
<Option name="FaceFrontColor" value="unknown type" /> 
<Option name="FogColor" value="unknown type" /> 
<Option name="FogDensity" value="0.0001" /> 
<Option name="FogEnd" value="100" /> 
<Option name="FogStart" value="0" /> 
<Option name="FogType" value="2" /> 
<Option name="FogUseBkColor" value="true" /> 
<Option name="ForegroundColor" value="unknown type" /> 
<Option name="GroundColor" value="unknown type" /> 
<Option name="GroundTransparency" value="50" /> 
<Option name="HideAnnotations" value="false" /> 
<Option name="HideConstructionGeometry" value="false" /> 
<Option name="HighlightColor" value="unknown type" /> 
<Option name="HorizonColor" value="unknown type" /> 
<Option name="InactiveHidden" value="false" /> 
<Option name="InstanceHidden" value="false" /> 
<Option name="JitterEdges" value="false" /> 
<Option name="LineEndWidth" value="5" /> 
<Option name="LineExtension" value="8" /> 
<Option name="LockedColor" value="unknown type" /> 
<Option name="MaterialTransparency" value="false" /> 
<Option name="ModelTransparency" value="false" /> 
<Option name="RenderMode" value="3" /> 
<Option name="SectionActiveColor" value="unknown type" /> 
<Option name="SectionCutWidth" value="4" /> 
<Option name="SectionDefaultCutColor" value="unknown type" /> 
<Option name="SectionInactiveColor" value="unknown type" /> 
<Option name="ShowViewName" value="true" /> 
<Option name="SilhouetteWidth" value="3" /> 
<Option name="SkyColor" value="unknown type" /> 
<Option name="Texture" value="true" /> 
<Option name="TransparencySort" value="0" /> 
</OptionsProvider>
- <OptionsProvider name="ShadowOptions">
<Option name="City" value="Boulder (CO)" /> 
<Option name="Country" value="USA" /> 
<Option name="Dark" value="20" /> 
<Option name="DaylightSavings" value="false" /> 
<Option name="DisplayNorth" value="false" /> 
<Option name="DisplayOnAllFaces" value="true" /> 
<Option name="DisplayOnGroundPlane" value="true" /> 
<Option name="DisplayShadows" value="false" /> 
<Option name="EdgesCastShadows" value="false" /> 
<Option name="Latitude" value="40.017" /> 
<Option name="Light" value="80" /> 
<Option name="Longitude" value="-105.283" /> 
<Option name="NorthAngle" value="0" /> 
<Option name="ShadowTime" value="0 0" /> 
<Option name="SunRise" value="0 2" /> 
<Option name="SunSet" value="0 1" /> 
<Option name="TZOffset" value="-7" /> 
<Option name="UseSunForAllShading" value="false" /> 
</OptionsProvider>
</Options>

Member Function Documentation

virtual unsigned int atlast::sketchup::ISketchUpOptionsManager::GetOptionProviderCount (  )  const [pure virtual]

Retrieves the number of ISketchUpOptionsProvider objects managed by this object.

Returns:
The number of managed ISketchUpOptionsProvider objects.
virtual ISketchUpOptionsProviderPtr atlast::sketchup::ISketchUpOptionsManager::GetOptionsProvider ( LPCWSTR  providerName  )  const [pure virtual]

Gets the option provider of the given name.

Returns:
The option provider of the given name if it exists, NULL otherwise.
virtual ISketchUpOptionsProviderPtr atlast::sketchup::ISketchUpOptionsManager::GetOptionsProvider ( unsigned int  indx  )  const [pure virtual]

Returns the i'th ISketchUpOptionProvider.

Returns:
The i'th ISketchUpOptionsProvider if i >= 0 and i < number of managed providers, NULL otherwise.

©2010 Google - Google Home - About Google