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

Public Member Functions | Properties

ISkpCamera Interface Reference

A camera object. More...

List of all members.

Public Member Functions

HRESULT _GetEye ([out] double pPoint3d[3])
 Returns the position of the camera.
HRESULT _GetDirection ([out] double pVector3d[3])
 Returns the direction vector for the camera.
HRESULT _GetUp ([out] double pVector3d[3])
 Returns the up direction vector for the camera.
HRESULT _GetCenter ([out] double pPoint3d[3])
 Returns the view center of the camera.
HRESULT _GetTarget ([out] double pPoint3d[3])
 Returns the target of the camera.

Properties

ISkpPoint3d Eye [get]
 [propget] Returns the position of the camera.
ISkpVector3d Direction [get]
 [propget] Returns the direction of the camera.
ISkpVector3d Up [get]
 [propget] Returns the up direction of the camera.
ISkpPoint3d Center [get]
 [propget] Returns the view center of the camera.
ISkpPoint3d Target [get]
 [propget] Returns the target of the camera.
long Projection [get]
 [propget] Returns the projection value of the camera.
double NearClip [get]
 [propget] Returns the near clipping distance of the camera.
double FarClip [get]
 [propget] Returns the far clipping distance of the camera.
double FieldOfView [get]
 [propget] Returns the field of view of the camera.
double Height [get]
 [propget] Returns the height of the camera.
double AspectRatio [get]
 [propget] Returns the aspect ratio of the camera.
BSTR Description [get]
 [propget] Returns the camera's description.
BOOL FieldOfViewIsHeight [get]
 [propget] Returns whether the field of view is measured in the y direction.
double ImageWidth [get]
 [propget] Returns the image width of the camera. The image width is used to relate the field of view to the length of the camera lens.
double Center2D ([out] double x) [get]
 Returns the 2D center of the camera.
double Scale2D [get]
 Returns the 2D scale of the camera.
BOOL Camera2D [get]
 [propget] Returns the 2D state of the camera.

Detailed Description

A camera object.


Member Function Documentation

HRESULT ISkpCamera::_GetCenter ( [out] double  pPoint3d[3]  ) 

Returns the view center of the camera.

It is assumed that the calling application has allocated space for the return values.

Return values:
pPoint3d The view center of the camera in model space.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT ISkpCamera::_GetDirection ( [out] double  pVector3d[3]  ) 

Returns the direction vector for the camera.

It is assumed that the calling application has allocated space for the return values.

Return values:
pVector3d The direction vector.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT ISkpCamera::_GetEye ( [out] double  pPoint3d[3]  ) 

Returns the position of the camera.

It is assumed that the calling application has allocated space for the return values.

Return values:
pPoint3d The position of the camera in model space.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT ISkpCamera::_GetTarget ( [out] double  pPoint3d[3]  ) 

Returns the target of the camera.

It is assumed that the calling application has allocated space for the return values.

Return values:
pPoint3d The target of the camera in model space.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT ISkpCamera::_GetUp ( [out] double  pVector3d[3]  ) 

Returns the up direction vector for the camera.

It is assumed that the calling application has allocated space for the return values.

Return values:
pVector3d The up direction vector.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors

Property Documentation

double ISkpCamera::AspectRatio [get]

[propget] Returns the aspect ratio of the camera.

If this function returns 0, then this property is not used, and the value should be ignored.

Return values:
pVal The aspect ratio of the camera.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BOOL ISkpCamera::Camera2D [get]

[propget] Returns the 2D state of the camera.

Return values:
pVal The 2D state of the camera (BOOL).
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpPoint3d ISkpCamera::Center [get]

[propget] Returns the view center of the camera.

Return values:
pPoint3d The view center of the camera in model space.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpCamera::Center2D([out] double x) [get]

Returns the 2D center of the camera.

It is assumed that the calling application has allocated space for the return values.

Return values:
pPoint2d The 2D center of the camera.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BSTR ISkpCamera::Description [get]

[propget] Returns the camera's description.

Return values:
pVal The camera's description.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpVector3d ISkpCamera::Direction [get]

[propget] Returns the direction of the camera.

Return values:
pVector3d The direction of the camera.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpPoint3d ISkpCamera::Eye [get]

[propget] Returns the position of the camera.

Return values:
pPoint3d The position of the camera in model space.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpCamera::FarClip [get]

[propget] Returns the far clipping distance of the camera.

Return values:
pVal The far clipping distance of the camera.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpCamera::FieldOfView [get]

[propget] Returns the field of view of the camera.

Return values:
pVal The field of view of the camera.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BOOL ISkpCamera::FieldOfViewIsHeight [get]

[propget] Returns whether the field of view is measured in the y direction.

Return values:
pVal true if field of view is measured by height.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpCamera::Height [get]

[propget] Returns the height of the camera.

This only applies in the parallel projection case.

Return values:
pVal The of the camera.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpCamera::ImageWidth [get]

[propget] Returns the image width of the camera. The image width is used to relate the field of view to the length of the camera lens.

Return values:
pVal = the width of the image on the "film".
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpCamera::NearClip [get]

[propget] Returns the near clipping distance of the camera.

Return values:
pVal The near clipping distance of the camera.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
long ISkpCamera::Projection [get]

[propget] Returns the projection value of the camera.

Return values:
pVal The projection value of the camera.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpCamera::Scale2D [get]

Returns the 2D scale of the camera.

It is assumed that the calling application has allocated space for the return values.

Return values:
Scale- The 2D scale of the camera.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpPoint3d ISkpCamera::Target [get]

[propget] Returns the target of the camera.

Return values:
pPoint3d The target of the camera in model space.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpVector3d ISkpCamera::Up [get]

[propget] Returns the up direction of the camera.

Return values:
pVector3d The up direction of the camera.
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