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

Public Member Functions | Properties

ISkpRenderer Interface Reference

An interface supported by those objects that can render a SketchUp model to a bitmap. More...

List of all members.

Public Member Functions

HRESULT GetPage ([out, retval]ISkpPage **ppPage)
 [propget] Returns a ISkpPage on the view that will be rendered.
HRESULT RenderToBitmap ([in] unsigned long width,[in] unsigned long height,[in] unsigned long bytesPerPixel,[in] unsigned long bytesPerRow,[in] unsigned long backgroundMode,[in] unsigned long format,[in] unsigned long type,[in] BOOL topToBottom,[in] BOOL nprSpeedMatters,[in] float outputDPI,[in] float linewidth,[in, out] unsigned char *bitmapBytes)
 Renderers the view and returns the bitmap in bitmapBytes.
HRESULT _GuessTarget ([out] double pPoint3d[3])
 Guess the point that the user is looking at based on the camera parameters.
HRESULT SetTileSize ([in] int width,[in] int height)
 Sets the max tile size width/height.
HRESULT RenderToFile ([in] unsigned long width,[in] unsigned long height,[in] unsigned long bytesPerPixel,[in] unsigned long bytesPerRow,[in] unsigned long backgroundMode,[in] unsigned long format,[in] unsigned long type,[in] BOOL topToBottom,[in] BOOL nprSpeedMatters,[in] float outputDPI,[in] float linewidth,[in] BSTR filename)
 Renders the view and creates a file with the given file name. The file contains the pixel data in the format that is passed in and at the resolution passed in.

Properties

ISkpView View [get]
 Get the ISkpView for this Renderer : ISkpView will have the lifetime of ISkpRenderer.

Detailed Description

An interface supported by those objects that can render a SketchUp model to a bitmap.


Member Function Documentation

HRESULT ISkpRenderer::_GuessTarget ( [out] double  pPoint3d[3]  ) 

Guess the point that the user is looking at based on the camera parameters.

Return values:
HRESULT 
Returns:
S_OK : if successful
HRESULT ISkpRenderer::GetPage ( [out, retval] ISkpPage **  ppPage  ) 

[propget] Returns a ISkpPage on the view that will be rendered.

Return values:
pVal The ISkpPage. This object is never NULL.
Returns:
S_OK : if successful
E_POINTER : if pVal == NULL
HRESULT ISkpRenderer::RenderToBitmap ( [in] unsigned long  width,
[in] unsigned long  height,
[in] unsigned long  bytesPerPixel,
[in] unsigned long  bytesPerRow,
[in] unsigned long  backgroundMode,
[in] unsigned long  format,
[in] unsigned long  type,
[in] BOOL  topToBottom,
[in] BOOL  nprSpeedMatters,
[in] float  outputDPI,
[in] float  linewidth,
[in, out] unsigned char *  bitmapBytes 
)

Renderers the view and returns the bitmap in bitmapBytes.

Return values:
HRESULT 
Returns:
S_OK : if successful
HRESULT ISkpRenderer::RenderToFile ( [in] unsigned long  width,
[in] unsigned long  height,
[in] unsigned long  bytesPerPixel,
[in] unsigned long  bytesPerRow,
[in] unsigned long  backgroundMode,
[in] unsigned long  format,
[in] unsigned long  type,
[in] BOOL  topToBottom,
[in] BOOL  nprSpeedMatters,
[in] float  outputDPI,
[in] float  linewidth,
[in] BSTR  filename 
)

Renders the view and creates a file with the given file name. The file contains the pixel data in the format that is passed in and at the resolution passed in.

Return values:
HRESULT 
Returns:
S_OK : if successful
HRESULT ISkpRenderer::SetTileSize ( [in] int  width,
[in] int  height 
)

Sets the max tile size width/height.

Return values:
HRESULT 
Returns:
S_OK : if successful

Property Documentation

ISkpView ISkpRenderer::View [get]

Get the ISkpView for this Renderer : ISkpView will have the lifetime of ISkpRenderer.

Return values:
HRESULT 
Returns:
S_OK : if successful

©2010 Google - Google Home - About Google