Describes a plane.
More...
List of all members.
Public Member Functions |
HRESULT | _GetPosition ([out] double pPoint3d[3]) |
| Returns a representative point on the plane.
|
HRESULT | _GetNormal ([out] double pVector3d[3]) |
| Returns the normal vector to the plane.
|
HRESULT | Get ([out]double *a,[out]double *b,[out]double *c,[out]double *d) |
| Returns a,b,c,d parameters describing the plane.
|
Properties |
ISkpPoint3d | Position [get] |
| [propget] Returns a representative point on the plane.
|
ISkpVector3d | Normal [get] |
| [propget] Returns the normal vector to the plane
|
Detailed Description
Describes a plane.
Instances of this object are disconnected from the model. They are read-only value objects.
Member Function Documentation
HRESULT ISkpPlane::_GetNormal |
( |
[out] double |
pVector3d[3] |
) |
|
Returns the normal vector to the plane.
- Note:
- This method can only be called when the COM server is "in process", as it shares memory addresses.
- Return values:
-
| pVector3d | The preallocated array of at least 3 doubles. |
- Returns:
- S_OK : if successful
E_POINTER : if pVector3d == NULL
HRESULT ISkpPlane::_GetPosition |
( |
[out] double |
pPoint3d[3] |
) |
|
Returns a representative point on the plane.
Computes a point on the plane. There is nothing special about this point.
- Note:
- This method can only be called when the COM server is "in process", as it shares memory addresses.
- Return values:
-
| pPoint3d | The preallocated array of at least 3 doubles. |
- Returns:
- S_OK : if successful
E_POINTER : if pPoint3d == NULL
HRESULT ISkpPlane::Get |
( |
[out] double * |
a, |
|
|
[out] double * |
b, |
|
|
[out] double * |
c, |
|
|
[out] double * |
d | |
|
) |
| | |
Returns a,b,c,d parameters describing the plane.
The parameters define all those points (x,y,z) that satisfy the equation
a*x + b*y + c*z = d
- Return values:
-
| pVector3d | The preallocated array of at least 3 doubles. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the given pointers are NULL
Property Documentation
[propget] Returns the normal vector to the plane
- Return values:
-
| pVector3d | The (unit) normal vector to the plane |
- Returns:
- S_OK : if successful
E_POINTER : if pVector3d == NULL
[propget] Returns a representative point on the plane.
Computes a point on the plane. There is nothing special about this point.
- Return values:
-
| pPoint3d | The representative point. |
- Returns:
- S_OK : if successful
E_POINTER : if pPoint3d == NULL