AnyCAD Rapid SDK  2020
The Rapid CAD SDK
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
GPln Class Reference

Public Member Functions

synchronized void delete ()
 
 GPln ()
 
 GPln (GAx3 A3)
 
 GPln (GPnt P, GDir V)
 
 GPln (double A, double B, double C, double D)
 
void Coefficients (double[] A, double[] B, double[] C, double[] D)
 
void SetAxis (GAx1 A1)
 
void SetLocation (GPnt Loc)
 
void SetPosition (GAx3 A3)
 
void UReverse ()
 
void VReverse ()
 
boolean Direct ()
 
GAx1 Axis ()
 
GPnt Location ()
 
GAx3 Position ()
 
double Distance (GPnt P)
 
double Distance (GLin L)
 
double Distance (GPln Other)
 
double SquareDistance (GPnt P)
 
double SquareDistance (GLin L)
 
double SquareDistance (GPln Other)
 
GAx1 XAxis ()
 
GAx1 YAxis ()
 
boolean Contains (GPnt P, double LinearTolerance)
 
boolean Contains (GLin L, double LinearTolerance, double AngularTolerance)
 
void Mirror (GPnt P)
 
GPln Mirrored (GPnt P)
 
void Mirror (GAx1 A1)
 
GPln Mirrored (GAx1 A1)
 
void Mirror (GAx2 A2)
 
GPln Mirrored (GAx2 A2)
 
void Rotate (GAx1 A1, double Ang)
 
GPln Rotated (GAx1 A1, double Ang)
 
void Scale (GPnt P, double S)
 
GPln Scaled (GPnt P, double S)
 
void Transform (GTrsf T)
 
GPln Transformed (GTrsf T)
 
void Translate (GVec V)
 
GPln Translated (GVec V)
 
void Translate (GPnt P1, GPnt P2)
 
GPln Translated (GPnt P1, GPnt P2)
 

Protected Member Functions

 GPln (long cPtr, boolean cMemoryOwn)
 
void finalize ()
 

Static Protected Member Functions

static long getCPtr (GPln obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

Describes a plane. A plane is positioned in space with a coordinate system (a gp_Ax3 object), such that the plane is defined by the origin, "X Direction" and "Y Direction" of this coordinate system, which is the "local coordinate system" of the plane. The "main Direction" of the coordinate system is a vector normal to the plane. It gives the plane an implicit orientation such that the plane is said to be "direct", if the coordinate system is right-handed, or "indirect" in the other case. Note: when a gp_Pln plane is converted into a Geom_Plane plane, some implicit properties of its local coordinate system are used explicitly: - its origin defines the origin of the two parameters of the planar surface, - its implicit orientation is also that of the Geom_Plane. See Also gce_MakePln which provides functions for more complex plane constructions Geom_Plane which provides additional functions for constructing planes and works, in particular, with the parametric equations of planes

Constructor & Destructor Documentation

GPln.GPln ( )

Creates a plane coincident with OXY plane of the reference coordinate system.

GPln.GPln ( GAx3  A3)

The coordinate system of the plane is defined with the axis placement A3. The "Direction" of A3 defines the normal to the plane. The "Location" of A3 defines the location (origin) of the plane. The "XDirection" and "YDirection" of A3 define the "XAxis" and the "YAxis" of the plane used to parametrize the plane.

GPln.GPln ( GPnt  P,
GDir  V 
)

Creates a plane with the "Location" point

and the normal direction <V>.

GPln.GPln ( double  A,
double  B,
double  C,
double  D 
)

Creates a plane from its cartesian equation : A * X + B * Y + C * Z + D = 0.0 Raises ConstructionError if Sqrt (A*A + B*B + C*C) <= Resolution from gp.

Member Function Documentation

GAx1 GPln.Axis ( )

Returns the plane's normal Axis.

void GPln.Coefficients ( double[]  A,
double[]  B,
double[]  C,
double[]  D 
)

Returns the coefficients of the plane's cartesian equation : A * X + B * Y + C * Z + D = 0.

boolean GPln.Contains ( GPnt  P,
double  LinearTolerance 
)

Returns true if this plane contains the point P. This means that - the distance between point P and this plane is less than or equal to LinearTolerance, or - line L is normal to the "main Axis" of the local coordinate system of this plane, within the tolerance AngularTolerance, and the distance between the origin of line L and this plane is less than or equal to LinearTolerance.

boolean GPln.Contains ( GLin  L,
double  LinearTolerance,
double  AngularTolerance 
)

Returns true if this plane contains the line L. This means that - the distance between point P and this plane is less than or equal to LinearTolerance, or - line L is normal to the "main Axis" of the local coordinate system of this plane, within the tolerance AngularTolerance, and the distance between the origin of line L and this plane is less than or equal to LinearTolerance.

boolean GPln.Direct ( )

returns true if the Ax3 is right handed.

double GPln.Distance ( GPnt  P)

Computes the distance between <me> and the point

.

double GPln.Distance ( GLin  L)

Computes the distance between <me> and the line <L>.

double GPln.Distance ( GPln  Other)

Computes the distance between two planes.

GPnt GPln.Location ( )

Returns the plane's location (origin).

GPln GPln.Mirrored ( GPnt  P)

Performs the symmetrical transformation of a plane with respect to the point

which is the center of the symmetry Warnings : The normal direction to the plane is not changed. The "XAxis" and the "YAxis" are reversed.

GPln GPln.Mirrored ( GAx1  A1)

Performs the symmetrical transformation of a plane with respect to an axis placement which is the axis of the symmetry. The transformation is performed on the "Location" point, on the "XAxis" and the "YAxis". The resulting normal direction is the cross product between the "XDirection" and the "YDirection" after transformation if the initial plane was right handed, else it is the opposite.

GPln GPln.Mirrored ( GAx2  A2)

Performs the symmetrical transformation of a plane with respect to an axis placement. The axis placement <A2> locates the plane of the symmetry. The transformation is performed on the "Location" point, on the "XAxis" and the "YAxis". The resulting normal direction is the cross product between the "XDirection" and the "YDirection" after transformation if the initial plane was right handed, else it is the opposite.

GAx3 GPln.Position ( )

Returns the local coordinate system of the plane .

GPln GPln.Rotated ( GAx1  A1,
double  Ang 
)

rotates a plane. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians.

GPln GPln.Scaled ( GPnt  P,
double  S 
)

Scales a plane. S is the scaling value.

void GPln.SetAxis ( GAx1  A1)

Modifies this plane, by redefining its local coordinate system so that - its origin and "main Direction" become those of the axis A1 (the "X Direction" and "Y Direction" are then recomputed). Raises ConstructionError if the A1 is parallel to the "XAxis" of the plane.

void GPln.SetLocation ( GPnt  Loc)

Changes the origin of the plane.

void GPln.SetPosition ( GAx3  A3)

Changes the local coordinate system of the plane.

double GPln.SquareDistance ( GPnt  P)

Computes the square distance between <me> and the point

.

double GPln.SquareDistance ( GLin  L)

Computes the square distance between <me> and the line <L>.

double GPln.SquareDistance ( GPln  Other)

Computes the square distance between two planes.

GPln GPln.Transformed ( GTrsf  T)

Transforms a plane with the transformation T from class Trsf. The transformation is performed on the "Location" point, on the "XAxis" and the "YAxis". The resulting normal direction is the cross product between the "XDirection" and the "YDirection" after transformation.

GPln GPln.Translated ( GVec  V)

Translates a plane in the direction of the vector V. The magnitude of the translation is the vector's magnitude.

GPln GPln.Translated ( GPnt  P1,
GPnt  P2 
)

Translates a plane from the point P1 to the point P2.

void GPln.UReverse ( )

Reverses the U parametrization of the plane reversing the XAxis.

void GPln.VReverse ( )

Reverses the V parametrization of the plane reversing the YAxis.

GAx1 GPln.XAxis ( )

Returns the X axis of the plane.

GAx1 GPln.YAxis ( )

Returns the Y axis of the plane.