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

Properties

ISkpPage Interface Reference

A page object. More...

List of all members.

Properties

BSTR Name [get]
 [propget] Returns the name of the page.
ISkpCamera Camera [get]
 [propget] Returns the camera of the page.
BOOL UseCamera [get]
 [propget] Determines whether the page uses the camera.
BOOL UseRenderingOptions [get]
 [propget] Determines whether the page uses rendering options.
BOOL UseShadowInfo [get]
 [propget] Determines whether the page uses shadowing options.
BOOL UseSketchCS [get]
 [propget] Determines whether the page uses sketch coordinate system.
BOOL UseHidden [get]
 [propget] Determines whether the page uses the hidden properties of entities.
BOOL UseHiddenLayers [get]
 [propget] Determines whether the page uses the hidden properties of layers.
ISkpOptionsProvider RenderingOptions [get]
 Gets the Rendering options associated with this page.
ISkpOptionsProvider ShadowOptions [get]
 Gets the Shadow options associated with this page.
ISkpCoordinateSystem CoordinateSystem [get]
 Gets the coordinate system used with this page - if any.
ISkpLayers Layers [get]
 [propget] Returns a Collection of all the ISkpLayer objects that have special settings on this Page. This is normally the Layers that are hidden on this Page.
ISkpEntities HiddenEntities [get]
 [propget] Returns a Collection of ISkpEntities that are hidden on this Page.
long Flags [get]
 [propget] Returns bitfiled indicating which values are saved.
BOOL SketchAxesDisplayed [get]
 [propget] Gets whether the sketch axes are displayed.
ISkpStyle Style [get]
 Get the Style associated with this page.
BOOL PhotoMatchImageDisplayed [get]
 [propget] Gets whether Photo Match image is displayed.

Detailed Description

A page object.


Property Documentation

ISkpCamera ISkpPage::Camera [get]

[propget] Returns the camera of the page.

Return values:
pVal The page's camera.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpCoordinateSystem ISkpPage::CoordinateSystem [get]

Gets the coordinate system used with this page - if any.

If this page does not have its own coordinate system, this method returns NULL.

See also:
ISkpPage::UseSketchCS
Return values:
ppCS The Coordinate system used by this page, if any.
long ISkpPage::Flags [get]

[propget] Returns bitfiled indicating which values are saved.

Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpEntities ISkpPage::HiddenEntities [get]

[propget] Returns a Collection of ISkpEntities that are hidden on this Page.

Return values:
pEntities The ISkpEntities collection.
Returns:
S_OK : if successful
S_FALSE: if get_UseHidden returns false
E_POINTER : if pLayers == NULL
ISkpLayers ISkpPage::Layers [get]

[propget] Returns a Collection of all the ISkpLayer objects that have special settings on this Page. This is normally the Layers that are hidden on this Page.

Return values:
pLayers The ISkpLayers collection.
Returns:
S_OK : if successful
S_FALSE: if Layers are not used on this Page
E_POINTER : if pLayers == NULL
BSTR ISkpPage::Name [get]

[propget] Returns the name of the page.

Return values:
pVal The page's name.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BOOL ISkpPage::PhotoMatchImageDisplayed [get]

[propget] Gets whether Photo Match image is displayed.

Return values:
pVal is set to TRUE if an image is displayed.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpOptionsProvider ISkpPage::RenderingOptions [get]

Gets the Rendering options associated with this page.

If the page does not use rendering options then this returns NULL.

See also:
ISkpPage::UseRenderingOptions
Return values:
ppRenderingOptions The rendering options used, if any.
ISkpOptionsProvider ISkpPage::ShadowOptions [get]

Gets the Shadow options associated with this page.

If the page does not use Shadow options then this returns NULL.

See also:
ISkpPage::UseShadowOptions
Return values:
ppShadowOptions The shadow options, if any.
BOOL ISkpPage::SketchAxesDisplayed [get]

[propget] Gets whether the sketch axes are displayed.

Return values:
pVal is set to TRUE if the axes are displayed.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
ISkpStyle ISkpPage::Style [get]

Get the Style associated with this page.

Parameters:
pVal The non-NULL return value into which to place the item.
Return values:
ppStyle The style.
Returns:
S_OK : if successful
E_POINTER : if pVal is NULL.
E_FAIL: Internal errors.
BOOL ISkpPage::UseCamera [get]

[propget] Determines whether the page uses the camera.

Return values:
pVal TRUE iff the page uses a camera.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BOOL ISkpPage::UseHidden [get]

[propget] Determines whether the page uses the hidden properties of entities.

Return values:
pVal TRUE iff the page uses the hidden properties.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BOOL ISkpPage::UseHiddenLayers [get]

[propget] Determines whether the page uses the hidden properties of layers.

Return values:
pVal TRUE iff the page uses the hidden properties of layers.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BOOL ISkpPage::UseRenderingOptions [get]

[propget] Determines whether the page uses rendering options.

Return values:
pVal TRUE iff the page uses the rendering options.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BOOL ISkpPage::UseShadowInfo [get]

[propget] Determines whether the page uses shadowing options.

Return values:
pVal TRUE iff the page uses the shadowing options.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BOOL ISkpPage::UseSketchCS [get]

[propget] Determines whether the page uses sketch coordinate system.

The Sketch coordinate system is referred to as the Sketch axes.

Return values:
pVal TRUE iff the page uses the sketch cs.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors

©2010 Google - Google Home - About Google