CFx SDK Documentation 2024 SP0
|
#include <GeVector3d.h>
Public Attributes | |
double | x |
double | y |
double | z |
Static Public Attributes | |
static GE_STATIC_EXPORT const OdGeVector3d | kIdentity |
static GE_STATIC_EXPORT const OdGeVector3d | kXAxis |
static GE_STATIC_EXPORT const OdGeVector3d | kYAxis |
static GE_STATIC_EXPORT const OdGeVector3d | kZAxis |
This class represents vectors in 3D space.
Corresponding C++ library: TD_Ge
<group OdGe_Classes>
Definition at line 54 of file GeVector3d.h.
|
inline |
Default constructor for the OdGeVector3d class.
Definition at line 64 of file GeVector3d.h.
|
inline |
Constructor for the OdGeVector3d class.
xx | [in] X-coordinate. |
yy | [in] Y-coordinate. |
zz | [in] Z-coordinate. |
Definition at line 76 of file GeVector3d.h.
OdGeVector3d::OdGeVector3d | ( | const OdGePlanarEnt & | plane, |
const OdGeVector2d & | vector2d | ||
) |
Constructor for the OdGeVector3d class.
plane | [in] 2D plane. |
vector2d | [in] 2D vector. |
uAxis * vect.x + vAxis * vect.y
where uAxis and vAxis are returned by
plane.get(origin, uAxis, vAxis)
double OdGeVector3d::angleOnPlane | ( | const OdGePlanarEnt & | plane | ) | const |
Returns the angle of this vector projected onto the specified plane
plane | [in] Any 3D plane. |
plane.getCoordSystem(origin, axis1, axis2)
double OdGeVector3d::angleTo | ( | const OdGeVector3d & | vect | ) | const |
Returns the angle to the specified vector.
vect | [in] Any 3D vector. |
double OdGeVector3d::angleTo | ( | const OdGeVector3d & | vect, |
const OdGeVector3d & | refVector | ||
) | const |
Returns the angle to the specified vector.
vect | [in] Any 3D vector. |
refVector | [in] Reference vector. |
|
inline |
Returns this vector as a point.
Definition at line 814 of file GeVector3d.h.
|
inline |
Returns this vector as a point.
Definition at line 807 of file GeVector3d.h.
OdGeVector2d OdGeVector3d::convert2d | ( | ) | const |
Returns the 2D vector, in the coordinate system of the XY plane, corresponding to the 3D vector.
OdGeVector2d OdGeVector3d::convert2d | ( | const OdGePlanarEnt & | plane | ) | const |
Returns the 2D vector, in the coordinate system of the plane, corresponding to the 3D vector.
plane | [in] The planar entity on which the converted vector will be projected. |
|
inline |
Returns the cross product of this vector and the specified vector.
vect | [in] Any 3D vector. |
Definition at line 595 of file GeVector3d.h.
|
inline |
Returns the dot product of this vector and the specified vector.
vect | [in] Any 3D vector. |
Definition at line 586 of file GeVector3d.h.
bool OdGeVector3d::isCodirectionalTo | ( | const OdGeVector3d & | vect, |
const OdGeTol & | tol, | ||
OdGeError & | status | ||
) | const |
Returns true if and only if the specified vector is codirectional to this vector within the specified tolerance.
vect | [in] Any 3D vector. |
tol | [in] Geometric tolerance. |
status | [out] Receives the status of test. |
Possible values for status are as follows:
@untitled table kOk k0This k0Arg1
bool OdGeVector3d::isCodirectionalTo | ( | const OdGeVector3d & | vect, |
const OdGeTol & | tol = OdGeContext::gTol |
||
) | const |
Returns true if and only if the specified vector is codirectional to this vector within the specified tolerance.
vect | [in] Any 3D vector. |
tol | [in] Geometric tolerance. |
bool OdGeVector3d::isEqualTo | ( | const OdGeVector3d & | vect, |
const OdGeTol & | tol = OdGeContext::gTol |
||
) | const |
Returns true if and only if vect is identical to this vector, within the specified tolerance.
vect | [in] Any 3D vector. |
tol | [in] Geometric tolerance. |
bool OdGeVector3d::isParallelTo | ( | const OdGeVector3d & | vect, |
const OdGeTol & | tol, | ||
OdGeError & | status | ||
) | const |
Returns true if and only if the specified vector is parallel to this vector within the specified tolerance.
vect | [in] Any 3D vector. |
tol | [in] Geometric tolerance. |
status | [out] Receives the status of test. |
Possible values for status are as follows:
@untitled table kOk k0This k0Arg1
bool OdGeVector3d::isParallelTo | ( | const OdGeVector3d & | vect, |
const OdGeTol & | tol = OdGeContext::gTol |
||
) | const |
Returns true if and only if the specified vector is parallel to this vector within the specified tolerance.
vect | [in] Any 3D vector. |
tol | [in] Geometric tolerance. |
bool OdGeVector3d::isPerpendicularTo | ( | const OdGeVector3d & | vect, |
const OdGeTol & | tol, | ||
OdGeError & | status | ||
) | const |
Returns true if and only if the specified vector is perpendicular to this vector within the specified tolerance.
vect | [in] Any 3D vector. |
tol | [in] Geometric tolerance. |
status | [out] Receives the status of test. |
Possible values for status are as follows:
@untitled table kOk k0This k0Arg1
bool OdGeVector3d::isPerpendicularTo | ( | const OdGeVector3d & | vect, |
const OdGeTol & | tol = OdGeContext::gTol |
||
) | const |
Returns true if and only if the specified vector is perpendicular to this vector within the specified tolerance.
vect | [in] Any 3D vector. |
tol | [in] Geometric tolerance. |
bool OdGeVector3d::isUnitLength | ( | const OdGeTol & | tol = OdGeContext::gTol | ) | const |
Returns true if and only if the length of this vector is 1.0 within the specified tolerance.
tol | [in] Geometric tolerance. |
bool OdGeVector3d::isZeroLength | ( | const OdGeTol & | tol = OdGeContext::gTol | ) | const |
Returns true if and only if the length of this vector is 0.0 within the specified tolerance.
tol | [in] Geometric tolerance. |
unsigned int OdGeVector3d::largestElement | ( | ) | const |
Returns the index of the largest absolute coordinate of this vector.
double OdGeVector3d::length | ( | ) | const |
Returns the length of this vector.
|
inline |
Returns the square of the length of this vector.
Definition at line 466 of file GeVector3d.h.
OdGeVector3d & OdGeVector3d::mirror | ( | const OdGeVector3d & | normalToPlane | ) |
Mirrors the entity about the plane passing through the origin with the specified normal, and returns a reference to the entity.
normalToPlane | [in] Normal to Plane. |
|
inline |
Negates this vector (-x, -y, -z), and returns a reference to this vector.
Definition at line 330 of file GeVector3d.h.
OdGeVector3d OdGeVector3d::normal | ( | const OdGeTol & | tol = OdGeContext::gTol | ) | const |
Returns the unit vector codirectional with this vector.
tol | [in] Geometric tolerance. |
OdGeVector3d & OdGeVector3d::normalize | ( | const OdGeTol & | tol, |
OdGe::ErrorCondition & | status | ||
) |
Sets this vector to the unit vector codirectional with this vector, and returns a reference to this vector
tol | [in] Geometric tolerance. |
status | [out] Receives the status of normalization. |
Possible values for status are as follows:
@untitled table kOk k0This
OdGeVector3d & OdGeVector3d::normalize | ( | const OdGeTol & | tol = OdGeContext::gTol | ) |
Sets this vector to the unit vector codirectional with this vector, and returns a reference to this vector
tol | [in] Geometric tolerance. |
double OdGeVector3d::normalizeGetLength | ( | double | tol = 1.e-300 | ) |
Sets this vector to the unit vector codirectional with this vector, and returns the length prior to normalization.
tol | [in] Tolerance. |
OdGeVector3d::operator OdGeMatrix3d | ( | ) | const |
Returns the equivalent 3D tranformation matrix.
bool OdGeVector3d::operator!= | ( | const OdGeVector3d & | vect | ) | const |
Inequality operator for the OdGeVector3d class.
vect | [in] A 3D vector to be compared. |
|
inline |
Multiplication operator for the OdGeVector3d class.
scale | [in] Scale factor. |
Definition at line 193 of file GeVector3d.h.
|
inline |
Multiplication operator for the OdGeVector3d class.
scale | [in] Scale factor. |
Definition at line 205 of file GeVector3d.h.
|
inline |
Addition operator for the OdGeVector3d class.
vect | [in] A 3D vector to be added. |
Definition at line 253 of file GeVector3d.h.
|
inline |
Addition operator for the OdGeVector3d class.
vect | [in] A 3D vector to be added. |
Definition at line 265 of file GeVector3d.h.
|
inline |
Returns a vector with inverted X, Y and Z coordinates.
Definition at line 325 of file GeVector3d.h.
|
inline |
Subtraction operator for the OdGeVector3d class.
vect | [in] A 3D vector to be subtracted. |
Definition at line 277 of file GeVector3d.h.
|
inline |
Subtraction operator for the OdGeVector3d class.
vect | [in] A 3D vector to be subtracted. |
Definition at line 289 of file GeVector3d.h.
|
inline |
Division operator for the OdGeVector3d class.
scale | [in] Scale factor. |
Definition at line 222 of file GeVector3d.h.
|
inline |
Division operator for the OdGeVector3d class.
scale | [in] Scale factor. |
Definition at line 236 of file GeVector3d.h.
bool OdGeVector3d::operator== | ( | const OdGeVector3d & | vect | ) | const |
Equality operator for the OdGeVector3d class.
vect | [in] A 3D vector to be compared. |
|
inline |
References the ith coordinate of this vector.
i | [in] Index of coordinate. |
Definition at line 710 of file GeVector3d.h.
|
inline |
Returns the ith coordinate of this vector.
i | [in] Index of coordinate. |
Definition at line 697 of file GeVector3d.h.
OdGeVector3d OdGeVector3d::orthoProject | ( | const OdGeVector3d & | planeNormal | ) | const |
Returns a 3D vector which is the result of the orthogonal projection of this vector into the plane with normal planeNormal passing through the origin.
planeNormal | [in] A 3D vector which is a normal vector of a plane on which this vector is projected. |
OdGeVector3d OdGeVector3d::orthoProject | ( | const OdGeVector3d & | planeNormal, |
const OdGeTol & | tol, | ||
OdGeError & | flag | ||
) | const |
Returns a 3D vector which is the result of the orthogonal projection of this vector into the plane with normal planeNormal passing through the origin.
planeNormal | [in] A 3D vector which is a normal vector of a plane on which this vector is projected. |
tol | [in] Geometric tolerance. |
flag | [in] A flag that displays if method executed successfully. |
OdGeVector3d OdGeVector3d::perpVector | ( | ) | const |
Returns a vector perpendicular to this one.
OdGeVector3d OdGeVector3d::project | ( | const OdGeVector3d & | planeNormal, |
const OdGeVector3d & | projectDirection | ||
) | const |
Returns a 3D vector which is the result of the projection of this vector in given projectDirection into the plane with normal planeNormal passing through the origin.
planeNormal | [in] A 3D vector which is a normal vector of a plane on which this vector is projected. |
projectDirection | [in] A projection direction. |
OdGeVector3d OdGeVector3d::project | ( | const OdGeVector3d & | planeNormal, |
const OdGeVector3d & | projectDirection, | ||
const OdGeTol & | tol, | ||
OdGeError & | flag | ||
) | const |
Returns a 3D vector which is the result of the projection of this vector in given projectDirection into the plane with normal planeNormal passing through the origin.
planeNormal | [in] A 3D vector which is a normal vector of a plane on which this vector is projected. |
projectDirection | [in] A projection direction. |
tol | [in] Geometric tolerance. |
flag | [in] A flag that displays if method executed successfully. |
@untitled table kOk k0Arg1 k0Arg2 kPerpendicularArg1Arg2
OdGeVector3d & OdGeVector3d::rotateBy | ( | double | angle, |
const OdGeVector3d & | axis | ||
) |
Rotates this vector the specified angle about the specified axis, and returns a reference to this vector.
angle | [in] Rotation angle. |
axis | [in] Axis of rotation. |
OdGeVector3d & OdGeVector3d::set | ( | const OdGePlanarEnt & | plane, |
const OdGeVector2d & | vect | ||
) |
Sets this vector to the specified arguments, and returns a reference to this vector.
vect | [in] Any 2D vector. |
plane | [in] Any plane. |
uAxis * vect.x + vAxis * vect.ywhere uAxis and vAxis are returned by
plane.get(origin, uAxis, vAxis)The 3D vector will be parallel to the 2D vector.
|
inline |
Sets this vector to the specified arguments, and returns a reference to this vector.
xx | [in] X-coordinate. |
yy | [in] Y-coordinate. |
zz | [in] Z-coordinate. |
Definition at line 725 of file GeVector3d.h.
void OdGeVector3d::setLength | ( | double | length | ) |
Sets the length of this vector.
length | [in] Vector length. |
OdGeVector3d & OdGeVector3d::setToProduct | ( | const OdGeMatrix3d & | matrix, |
const OdGeVector3d & | vect | ||
) |
Sets this vector to the product matrix * vect and returns a reference to this vector.
matrix | [in] Any 3D matrix. |
vect | [in] Any 3D vector. |
|
inline |
Sets this vector to the product scale * vect and returns a reference to this vector.
vect | [in] Any 3D vector. |
scale | [in] Scale factor. |
Definition at line 123 of file GeVector3d.h.
|
inline |
Sets this vector to vector1 + vector1, and returns a reference to this vector.
vector1 | [in] Any 3D vector. |
vector2 | [in] Any 3D vector. |
Definition at line 309 of file GeVector3d.h.
OdGeVector3d & OdGeVector3d::transformBy | ( | const OdGeMatrix3d & | xfm | ) |
Applies the 3D transformation matrix to this vector.
xfm | [in] 3D transformation matrix. |
|
static |
Definition at line 100 of file GeVector3d.h.
|
static |
Definition at line 101 of file GeVector3d.h.
|
static |
Definition at line 102 of file GeVector3d.h.
|
static |
Definition at line 103 of file GeVector3d.h.
double OdGeVector3d::x |
Definition at line 771 of file GeVector3d.h.
double OdGeVector3d::y |
Definition at line 772 of file GeVector3d.h.
double OdGeVector3d::z |
Definition at line 773 of file GeVector3d.h.