An interface exposing view capabilities.
More...
List of all members.
Public Member Functions |
HRESULT | PixelToModel ([in]long pixels,[in]double *pPoint3d,[out]double *pVal) |
| Covert given number of pixels at the given world point to a world size.
|
HRESULT | GetPixelsPerInch ([out]long *x,[out]long *y) |
| Returns the x and y pixels per inch.
|
HRESULT | _GetDirection ([out]double pVector3d[3]) |
| Returns the direction vector association with this view.
|
HRESULT | _GetXVec ([out]double pVector3d[3]) |
| Returns the x-vector association with this view.
|
HRESULT | _GetYVec ([out]double pVector3d[3]) |
| Returns the y-vector association with this view.
|
HRESULT | MapToViewport ([in] double *pModelSpacePoint3d,[out]double *pViewportPoint3d,[out]BOOL *pSuccess) |
| Map a model space point into viewport coordinates.
|
HRESULT | GetScreenDimensions ([out] long *x,[out] long *y) |
| Retrieves the screen height and width in pixels.
|
Properties |
ISkpVector3d | Direction [get] |
| [propget] Returns the direction vector association with this view.
|
ISkpVector3d | XVec [get] |
| [propget] Returns the x-vector association with this view.
|
ISkpVector3d | YVec [get] |
| [propget] Returns the x-vector association with this view.
|
Detailed Description
An interface exposing view capabilities.
- Examples:
-
GetCurrentView.cpp.
Member Function Documentation
HRESULT ISkpView::_GetDirection |
( |
[out] double |
pVector3d[3] |
) |
|
Returns the direction vector association with this view.
This method assumes that the calling application has allocated the array of 3 doubles that it passes to this call.
- Parameters:
-
| pVector3d | The vector representing the direction of the view. |
- Returns:
- S_OK : if successful
E_POINTER : if pVector3d is NULL.
E_FAIL: Internal errors.
HRESULT ISkpView::_GetXVec |
( |
[out] double |
pVector3d[3] |
) |
|
Returns the x-vector association with this view.
This method assumes that the calling application has allocated the array of 3 doubles that it passes to this call.
- Parameters:
-
| pVector3d | The vector representing the x-vector of the view. |
- Returns:
- S_OK : if successful
E_POINTER : if pVector3d is NULL.
E_FAIL: Internal errors.
HRESULT ISkpView::_GetYVec |
( |
[out] double |
pVector3d[3] |
) |
|
Returns the y-vector association with this view.
This method assumes that the calling application has allocated the array of 3 doubles that it passes to this call.
- Parameters:
-
| pVector3d | The vector representing the y-vector of the view. |
- Returns:
- S_OK : if successful
E_POINTER : if pVector3d is NULL.
E_FAIL: Internal errors.
HRESULT ISkpView::GetPixelsPerInch |
( |
[out] long * |
x, |
|
|
[out] long * |
y | |
|
) |
| | |
Returns the x and y pixels per inch.
- Parameters:
-
| x | The number of x pixels per inch. |
| y | The number of y pixels per inch. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the inputs is NULL.
E_FAIL: Internal errors.
HRESULT ISkpView::GetScreenDimensions |
( |
[out] long * |
x, |
|
|
[out] long * |
y | |
|
) |
| | |
Retrieves the screen height and width in pixels.
- Parameters:
-
| x | The width, in pixels, of the current screen. |
| y | The height, in pixels, of the current screen. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the arguments are NULL.
E_FAIL: Internal errors.
HRESULT ISkpView::MapToViewport |
( |
[in] double * |
pModelSpacePoint3d, |
|
|
[out] double * |
pViewportPoint3d, |
|
|
[out] BOOL * |
pSuccess | |
|
) |
| | |
Map a model space point into viewport coordinates.
This method assumes that the pModelSpacePoint3d parameter is an array of 3 doubles allocated by the caller, as is the pViewportPoint3d parameter.
- Parameters:
-
| pModelSpacePoint3d | A caller allocated array of 3 doubles containing the model space coordinates. |
| pViewportPoint3d | A caller allocated array of 3 doubles into which this method will populate the viewport coordinates for the given pViewportPoint3d parameter. |
| pSuccess | TRUE iff the operation succeeded. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the arguments are NULL.
E_FAIL: Internal errors.
HRESULT ISkpView::PixelToModel |
( |
[in] long |
pixels, |
|
|
[in] double * |
pPoint3d, |
|
|
[out] double * |
pVal | |
|
) |
| | |
Covert given number of pixels at the given world point to a world size.
- Parameters:
-
| pixels | The number of pixels to convert. |
| pPoint3d | An array of 3 doubles representing the point in world coordinates to be converted to world size. |
| pVal | The output world size. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the inputs is NULL.
E_FAIL: Internal errors.
Property Documentation
[propget] Returns the direction vector association with this view.
- Parameters:
-
| pVector3d | The vector representing the direction of the view. |
- Returns:
- S_OK : if successful
E_POINTER : if pVector3d is NULL.
E_FAIL: Internal errors.
[propget] Returns the x-vector association with this view.
- Parameters:
-
| pVector3d | The vector representing the x-vector of the view. |
- Returns:
- S_OK : if successful
E_POINTER : if pVector3d is NULL.
E_FAIL: Internal errors.
[propget] Returns the x-vector association with this view.
- Parameters:
-
| pVector3d | The vector representing the x-vector of the view. |
- Returns:
- S_OK : if successful
E_POINTER : if pVector3d is NULL.
E_FAIL: Internal errors.