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

Public Member Functions | Properties

ISkpCameraM Interface Reference

An interface for modifying a camera object. More...

List of all members.

Public Member Functions

HRESULT _SetOrientation ([in] double eye[3],[in] double target[3],[in] double up[3])
 Set the orientation of the camera.
HRESULT SetOrientation ([in] ISkpPoint3d *eye,[in] ISkpPoint3d *target,[in] ISkpVector3d *up)
 Set the orientation of the camera.
HRESULT SetCenter ([in] ISkpPoint3d *pCenter)
 Set the center of projection of the camera.
HRESULT _SetCenter ([in] double center[3])
 Set the center of projection of the camera.

Properties

long Projection [set]
 [propput] Sets the projection value of the camera.
double NearClip [set]
 [propput] Sets the near clipping distance of the camera.
double FarClip [set]
 [propput] Sets the far clipping distance of the camera.
double FieldOfView [set]
 [propput] Sets the field of view of the camera.
double Height [set]
 [propput] Sets the height of the camera.
double AspectRatio [set]
 [propput] Sets the aspect ratio of the camera.
BSTR Description [set]
 [propput] Sets the camera's description.
BOOL FieldOfViewIsHeight [set]
 [propput] Sets whether the field of view is measured in the y direction.
double ImageWidth [set]
 [propput] Sets the image width of the camera.
double Center2D ([in] double x) [set]
 Sets the 2D center of the camera.
double Scale2D [set]
 Sets the 2D scale of the camera.
BOOL Camera2D [set]
 [propget] Sets the camera's 2D state.

Detailed Description

An interface for modifying a camera object.


Member Function Documentation

HRESULT ISkpCameraM::_SetCenter ( [in] double  center[3]  ) 

Set the center of projection of the camera.

Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT ISkpCameraM::_SetOrientation ( [in] double  eye[3],
[in] double  target[3],
[in] double  up[3] 
)

Set the orientation of the camera.

Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT ISkpCameraM::SetCenter ( [in] ISkpPoint3d pCenter  ) 

Set the center of projection of the camera.

Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT ISkpCameraM::SetOrientation ( [in] ISkpPoint3d eye,
[in] ISkpPoint3d target,
[in] ISkpVector3d up 
)

Set the orientation of the camera.

Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors

Property Documentation

double ISkpCameraM::AspectRatio [set]

[propput] Sets 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 ISkpCameraM::Camera2D [set]

[propget] Sets the camera's 2D state.

Return values:
pVal The 2D state of the camera.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpCameraM::Center2D([in] double x) [set]

Sets 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 ISkpCameraM::Description [set]

[propput] Sets the camera's description.

Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpCameraM::FarClip [set]

[propput] Sets 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 ISkpCameraM::FieldOfView [set]

[propput] Sets 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 ISkpCameraM::FieldOfViewIsHeight [set]

[propput] Sets whether the field of view is measured in the y direction.

Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpCameraM::Height [set]

[propput] Sets the height of the camera.

This only applies in the parallel projection case.

Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpCameraM::ImageWidth [set]

[propput] Sets the image width of the camera.

Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpCameraM::NearClip [set]

[propput] Sets 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 ISkpCameraM::Projection [set]

[propput] Sets 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 ISkpCameraM::Scale2D [set]

Sets the 2D scale of the camera.

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

©2010 Google - Google Home - About Google