This reference page is linked to from the following overview
topics: Softimage 2012.
#include <xsi_line.h>
Class Description
A parametric 3D line.
- See also:
-
CVector3, CPlane
- Example:
List of all
members.
Constructor & Destructor Documentation
| SICPPSDK_INLINE CLine |
( |
|
) |
|
Construct a line through given point in given direction.
- Parameters:
-
| in_point |
Point on the line |
| in_tangent |
Tangent direction vector |
Copy constructor.
- Parameters:
-
| SICPPSDK_INLINE ~CLine |
( |
|
) |
|
Member Function Documentation
| SICPPSDK_INLINE CLine & operator= |
( |
const CLine & |
in_line |
) |
|
Assignment operator.
- Parameters:
-
- Returns:
- A reference to this line.
| SICPPSDK_INLINE bool operator== |
( |
const CLine & |
in_line |
) |
const |
Equality operator tests the strict equality of this CLine with the specified line.
- Parameters:
-
- Returns:
- true if equal else false.
- See also:
- CLine::Equals
| SICPPSDK_INLINE bool operator!= |
( |
const CLine & |
in_line |
) |
const |
Inequality operator tests the strict inequality of this
CLine with the specified line.
- Parameters:
-
- Returns:
- true if equal else false.
- See also:
- CLine::Equals
| SICPPSDK_INLINE bool EpsilonEquals |
( |
const CLine & |
in_line, |
|
|
double |
in_dEpsilon |
|
) |
|
const |
Tests the equality of this line with the specified line, with a
tolerance of Epsilon.
- Parameters:
-
| in_line |
Operand line. |
| in_dEpsilon |
Error margin
Possible Values: [0, +INF[ should be a positive
value |
- Returns:
- true if equal else false.
| SICPPSDK_INLINE bool Equals |
( |
const CLine & |
in_line |
) |
const |
Tests the strict equality of this line with the specified
line.
- Parameters:
-
- Returns:
- true if equal else false.
| bool Parallel |
( |
const CLine & |
in_line |
) |
const |
Tests whether two lines are parallel.
- Parameters:
-
- Returns:
- true if equal else false.
| bool Collinear |
( |
const CLine & |
in_line |
) |
const |
Tests whether two lines are collinear.
- Parameters:
-
- Returns:
- true if equal else false.
Return projection of given point on this line.
- Returns:
- Closest point on the line
| SICPPSDK_INLINE CVector3
GetClosestPoint |
( |
const CLine & |
in_line |
) |
const |
Return closest point on the the line to the given line.
- Returns:
- Closest point on the line
| SICPPSDK_INLINE double GetDistance |
( |
const CVector3 & |
in_point |
) |
const |
Return distance fromt the line to the given point.
- Returns:
- Distance to input point
| SICPPSDK_INLINE double GetDistance |
( |
const CLine & |
in_line |
) |
const |
Return distance fromt the line to the given line.
- Returns:
- Distance to input line
| SICPPSDK_INLINE CVector3 GetPosition |
( |
double |
in_param |
) |
const |
Return position on line for given parameter.
- Parameters:
-
- Returns:
- Position corresponding to input parameter
| double GetParameter |
( |
const CVector3 & |
in_point |
) |
const |
Return parameter on line closest to input point.
- Returns:
- Position corresponding to input parameter
| bool Intersect |
( |
const CLine & |
in_line, |
|
|
CVector3 & |
out_point |
|
) |
|
const |
Return intersection of this line with the given line.
- Parameters:
-
| in_line |
Line to intersect. |
| out_point |
Closest point of intersection on line. |
- Returns:
- true if lines intersect at a single point else false.
| SICPPSDK_INLINE const CVector3 &
GetOrigin |
( |
|
) |
const |
Return origin of the line.
- Returns:
- Reference to origin.
| SICPPSDK_INLINE const CVector3 &
GetTangent |
( |
|
) |
const |
Return tangent direction of the line.
- Returns:
- Reference to tangent.
Set origin of the line.
- Parameters:
-
| in_point |
Point on the line |
- Returns:
- A reference to this line.
| SICPPSDK_INLINE CLine & SetTangent |
( |
const CVector3 & |
in_tangent |
) |
|
Set tangent direction of the line.
- Parameters:
-
| in_tangent |
Tangent direction vector. |
- Returns:
- A reference to this line.
Set origin and tangent direction of the line.
- Parameters:
-
| in_point |
Point on the line |
| in_tangent |
Tangent direction vector. |
- Returns:
- A reference to this line.
| SICPPSDK_INLINE CLine & operator*= |
( |
const CMatrix3 & |
in_matrix3 |
) |
|
Right-multiplies this line by the matrix m in place (this = this
. m ).
- Parameters:
-
| in_matrix3 |
Operand matrix. |
- Returns:
- A reference to this line.
- See also:
- CLine::MulByMatrix3InPlace
| SICPPSDK_INLINE CLine & operator*= |
( |
const CMatrix4 & |
in_matrix4 |
) |
|
Right-multiplies this line by the matrix m in place (this = this
. m ).
- Parameters:
-
| in_matrix4 |
Operand matrix. |
- Returns:
- A reference to this line.
- See also:
- CLine::MulByMatrix4InPlace
Right-multiplies this line by the transformation t in place
(this = this . t).
- Parameters:
-
| in_transformation |
transformation operand. |
- Returns:
- A reference to this line.
- See also:
- CLine::MulByTransformationInPlace
| SICPPSDK_INLINE CLine &
MulByMatrix3InPlace |
( |
const CMatrix3 & |
in_matrix3 |
) |
|
Right-multiplies this line by the matrix m in place (this = this
. m ).
- Parameters:
-
| in_matrix3 |
Operand matrix. |
- Returns:
- A reference to this line.
| SICPPSDK_INLINE CLine & MulByMatrix3 |
( |
const CLine & |
in_line, |
|
|
const CMatrix3 & |
in_matrix3 |
|
) |
|
|
Right-multiplies the line l by the matrix m and store the result
in this line (this = l . m ).
- Parameters:
-
| in_line |
Operand line |
| in_matrix3 |
Operand matrix. |
- Returns:
- A reference to this line.
| SICPPSDK_INLINE CLine &
MulByMatrix4InPlace |
( |
const CMatrix4 & |
in_matrix4 |
) |
|
Right-multiplies this line by the matrix m in place (this = this
. m ).
- Parameters:
-
| in_matrix4 |
Operand matrix. |
- Returns:
- A reference to this line.
| SICPPSDK_INLINE CLine & MulByMatrix4 |
( |
const CLine & |
in_line, |
|
|
const CMatrix4 & |
in_matrix4 |
|
) |
|
|
Right-multiplies the line l by the matrix m and store the result
in this line (this = l . m ).
- Parameters:
-
| in_line |
Operand line |
| in_matrix4 |
Operand matrix. |
- Returns:
- A reference to this line.
Right-multiplies this line by the transformation t in place
(this = this . t).
- Parameters:
-
| in_transformation |
transformation operand. |
- Returns:
- A reference to this line.
Right-multiplies the line l by the transformation t and stores
the result in this line (this = l . t ).
- Parameters:
-
| in_line |
Operand line. |
| in_transformation |
transformation operand. |
- Returns:
- A reference to this line.
The documentation for this class was generated from the following
file:
