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

Properties

ISkpDocument Interface Reference

The model, including all entities and supporting meta-data. More...

Inheritance diagram for ISkpDocument:
SkpDocument

List of all members.

Properties

ISkpApplication Application [get]
 [propget] Returns the ISkpApplication which provides this document.
ISkpBoundingBox3d ModelExtents [get]
 [propget] Returns the bounding box for the entire model.
ISkpFonts Fonts [get]
 [propget] Returns a Collection of all the ISkpFont objects within this document.
ISkpMaterials Materials [get]
 [propget] Returns a Collection of all the ISkpMaterial objects within this document.
ISkpLayers Layers [get]
 [propget] Returns a Collection of all the ISkpLayer objects within this document.
ISkpOptionsManager OptionsManager [get]
 [propget] Returns the ISkpOptionsManager for this document.
ISkpComponentDefinitions ComponentDefinitions [get]
 [propget] Returns a Collection of all the ISkpComponentDefinition objects within this document.
ISkpCamera CurrentCamera [get]
 [propget] Returns the current camera used by this document.
ISkpPages Pages [get]
 [propget] Returns a Collection of all the ISkpPage objects within this document.
ISkpSelectionSet SelectionSet [get]
 [propget] Returns the current selection
BSTR Description [get]
 [propget] Returns the description of the document.
ISkpRenderer Renderer [get]
 [propget] Returns a interface to render to a bitmap.
ISkpOptionsProvider ShadowOptions [get]
 Gets the current Shadow options.
ISkpStyleManager StyleManager [get]
 [propget] Returns the ISkpStyleManager for this document.
ISkpBoundingBox3d ModelExtentsLLA [get]
 [propget] Returns the bounding box for the entire model in LLA coordinates.
ISkpHLRView HLRView [get]
 [propget] Returns a interface to an HLRView.
ISkpCameraM CurrentCameraM [get]
 [propget] Returns (mutable) current camera used by this document.

Detailed Description

The model, including all entities and supporting meta-data.

See also:
ISkpEntityProvider

Property Documentation

ISkpApplication ISkpDocument::Application [get]

[propget] Returns the ISkpApplication which provides this document.

Return values:
pVal The providing ISkpApplication.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpComponentDefinitions ISkpDocument::ComponentDefinitions [get]

[propget] Returns a Collection of all the ISkpComponentDefinition objects within this document.

Return values:
pDefinitions The ISkpComponentDefinitions collection. This object is never NULL.
Returns:
S_OK : if successful
E_POINTER : if pDefinitions == NULL
ISkpCamera ISkpDocument::CurrentCamera [get]

[propget] Returns the current camera used by this document.

This method is used to retrieve the current, active, camera. This camera may or may not be the camera associated with the current active page.

Return values:
pVal The current, active ISkpCamera object.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpCameraM ISkpDocument::CurrentCameraM [get]

[propget] Returns (mutable) current camera used by this document.

This method is used to retrieve the current, active, camera. This camera may or may not be the camera associated with the current active page.

Return values:
pVal The current, active ISkpCameraM object.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
BSTR ISkpDocument::Description [get]

[propget] Returns the description of the document.

Return values:
pDesc The document's description.
Returns:
S_OK : if successful
E_POINTER : if pDesc == NULL
ISkpFonts ISkpDocument::Fonts [get]

[propget] Returns a Collection of all the ISkpFont objects within this document.

Return values:
pVal The ISkpFonts collection. This object is never NULL.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpHLRView ISkpDocument::HLRView [get]

[propget] Returns a interface to an HLRView.

Return values:
pVal The ISkpHLRView. This object is never NULL.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpLayers ISkpDocument::Layers [get]

[propget] Returns a Collection of all the ISkpLayer objects within this document.

Return values:
pLayers The ISkpLayers collection. This object is never NULL.
Returns:
S_OK : if successful
E_POINTER : if pLayers == NULL
ISkpMaterials ISkpDocument::Materials [get]

[propget] Returns a Collection of all the ISkpMaterial objects within this document.

Return values:
pVal The ISkpMaterials collection. This object is never NULL.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpBoundingBox3d ISkpDocument::ModelExtents [get]

[propget] Returns the bounding box for the entire model.

Return values:
pVal The bounding ISkpBoundingBox3d.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpBoundingBox3d ISkpDocument::ModelExtentsLLA [get]

[propget] Returns the bounding box for the entire model in LLA coordinates.

Return values:
pVal The bounding ISkpBoundingBox3d.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpOptionsManager ISkpDocument::OptionsManager [get]

[propget] Returns the ISkpOptionsManager for this document.

Return values:
pVal The ISkpOptionsManager for this document.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpPages ISkpDocument::Pages [get]

[propget] Returns a Collection of all the ISkpPage objects within this document.

Return values:
pVal The ISkpPages collection. This object is never NULL.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpRenderer ISkpDocument::Renderer [get]

[propget] Returns a interface to render to a bitmap.

Return values:
pVal The ISkpRenderer. This object is never NULL.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpSelectionSet ISkpDocument::SelectionSet [get]

[propget] Returns the current selection

Return values:
pVal The current selection set.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpOptionsProvider ISkpDocument::ShadowOptions [get]

Gets the current Shadow options.

There may be no Pages, so there's no "Selected Page" to query Shadow options.

Return values:
ppShadowOptions The shadow options.
ISkpStyleManager ISkpDocument::StyleManager [get]

[propget] Returns the ISkpStyleManager for this document.

Return values:
pVal The ISkpStyleManager for this document.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL

©2010 Google - Google Home - About Google