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

Public Member Functions

synchronized void delete ()
 
 GHypr2d ()
 
 GHypr2d (GAx2d MajorAxis, double MajorRadius, double MinorRadius, boolean Sense)
 
 GHypr2d (GAx2d MajorAxis, double MajorRadius, double MinorRadius)
 
 GHypr2d (GAx22d A, double MajorRadius, double MinorRadius)
 
void SetLocation (GPnt2d P)
 
void SetMajorRadius (double MajorRadius)
 
void SetMinorRadius (double MinorRadius)
 
void SetAxis (GAx22d A)
 
void SetXAxis (GAx2d A)
 
void SetYAxis (GAx2d A)
 
GAx2d Asymptote1 ()
 
GAx2d Asymptote2 ()
 
void Coefficients (double[] A, double[] B, double[] C, double[] D, double[] E, double[] F)
 
GHypr2d ConjugateBranch1 ()
 
GHypr2d ConjugateBranch2 ()
 
GAx2d Directrix1 ()
 
GAx2d Directrix2 ()
 
double Eccentricity ()
 
double Focal ()
 
GPnt2d Focus1 ()
 
GPnt2d Focus2 ()
 
GPnt2d Location ()
 
double MajorRadius ()
 
double MinorRadius ()
 
GHypr2d OtherBranch ()
 
double Parameter ()
 
GAx22d Axis ()
 
GAx2d XAxis ()
 
GAx2d YAxis ()
 
void Reverse ()
 
GHypr2d Reversed ()
 
boolean IsDirect ()
 
void Mirror (GPnt2d P)
 
GHypr2d Mirrored (GPnt2d P)
 
void Mirror (GAx2d A)
 
GHypr2d Mirrored (GAx2d A)
 
void Rotate (GPnt2d P, double Ang)
 
GHypr2d Rotated (GPnt2d P, double Ang)
 
void Scale (GPnt2d P, double S)
 
GHypr2d Scaled (GPnt2d P, double S)
 
void Transform (GTrsf2d T)
 
GHypr2d Transformed (GTrsf2d T)
 
void Translate (GVec2d V)
 
GHypr2d Translated (GVec2d V)
 
void Translate (GPnt2d P1, GPnt2d P2)
 
GHypr2d Translated (GPnt2d P1, GPnt2d P2)
 

Protected Member Functions

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

Static Protected Member Functions

static long getCPtr (GHypr2d obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

Describes a branch of a hyperbola in the plane (2D space). A hyperbola is defined by its major and minor radii, and positioned in the plane with a coordinate system (a gp_Ax22d object) of which: - the origin is the center of the hyperbola, - the "X Direction" defines the major axis of the hyperbola, and - the "Y Direction" defines the minor axis of the hyperbola. This coordinate system is the "local coordinate system" of the hyperbola. The orientation of this coordinate system (direct or indirect) gives an implicit orientation to the hyperbola. In this coordinate system, the equation of the hyperbola is: X*X/(MajorRadius**2)-Y*Y/(MinorRadius**2) = 1.0 The branch of the hyperbola described is the one located on the positive side of the major axis. The following schema shows the plane of the hyperbola, and in it, the respective positions of the three branches of hyperbolas constructed with the functions OtherBranch, ConjugateBranch1, and ConjugateBranch2: ^YAxis | FirstConjugateBranch | Other | Main ------------------— C ---------------------------—>XAxis Branch | Branch | | SecondConjugateBranch | Warning The major radius can be less than the minor radius. See Also gce_MakeHypr2d which provides functions for more complex hyperbola constructions Geom2d_Hyperbola which provides additional functions for constructing hyperbolas and works, in particular, with the parametric equations of hyperbolas

Constructor & Destructor Documentation

GHypr2d.GHypr2d ( )

Creates of an indefinite hyperbola.

GHypr2d.GHypr2d ( GAx2d  MajorAxis,
double  MajorRadius,
double  MinorRadius,
boolean  Sense 
)

Creates a hyperbola with radii MajorRadius and MinorRadius, centered on the origin of MajorAxis and where the unit vector of MajorAxis is the "X Direction" of the local coordinate system of the hyperbola. This coordinate system is direct if Sense is true (the default value), and indirect if Sense is false. Warnings : It is yet possible to create an Hyperbola with MajorRadius <= MinorRadius. Raises ConstructionError if MajorRadius < 0.0 or MinorRadius < 0.0

GHypr2d.GHypr2d ( GAx2d  MajorAxis,
double  MajorRadius,
double  MinorRadius 
)

Creates a hyperbola with radii MajorRadius and MinorRadius, centered on the origin of MajorAxis and where the unit vector of MajorAxis is the "X Direction" of the local coordinate system of the hyperbola. This coordinate system is direct if Sense is true (the default value), and indirect if Sense is false. Warnings : It is yet possible to create an Hyperbola with MajorRadius <= MinorRadius. Raises ConstructionError if MajorRadius < 0.0 or MinorRadius < 0.0

GHypr2d.GHypr2d ( GAx22d  A,
double  MajorRadius,
double  MinorRadius 
)

a hyperbola with radii MajorRadius and MinorRadius, positioned in the plane by coordinate system A where: - the origin of A is the center of the hyperbola, - the "X Direction" of A defines the major axis of the hyperbola, that is, the major radius MajorRadius is measured along this axis, and - the "Y Direction" of A defines the minor axis of the hyperbola, that is, the minor radius MinorRadius is measured along this axis, and - the orientation (direct or indirect sense) of A gives the implicit orientation of the hyperbola. Warnings : It is yet possible to create an Hyperbola with MajorRadius <= MinorRadius. Raises ConstructionError if MajorRadius < 0.0 or MinorRadius < 0.0

Member Function Documentation

GAx2d GHypr2d.Asymptote1 ( )

In the local coordinate system of the hyperbola the equation of the hyperbola is (X*X)/(A*A) - (Y*Y)/(B*B) = 1.0 and the equation of the first asymptote is Y = (B/A)*X where A is the major radius of the hyperbola and B the minor radius of the hyperbola. Raises ConstructionError if MajorRadius = 0.0

GAx2d GHypr2d.Asymptote2 ( )

In the local coordinate system of the hyperbola the equation of the hyperbola is (X*X)/(A*A) - (Y*Y)/(B*B) = 1.0 and the equation of the first asymptote is Y = -(B/A)*X where A is the major radius of the hyperbola and B the minor radius of the hyperbola. Raises ConstructionError if MajorRadius = 0.0

GAx22d GHypr2d.Axis ( )

Returns the axisplacement of the hyperbola.

void GHypr2d.Coefficients ( double[]  A,
double[]  B,
double[]  C,
double[]  D,
double[]  E,
double[]  F 
)

Computes the coefficients of the implicit equation of the hyperbola : A * (X**2) + B * (Y**2) + 2*C*(X*Y) + 2*D*X + 2*E*Y + F = 0.

GHypr2d GHypr2d.ConjugateBranch1 ( )

Computes the branch of hyperbola which is on the positive side of the "YAxis" of <me>.

GHypr2d GHypr2d.ConjugateBranch2 ( )

Computes the branch of hyperbola which is on the negative side of the "YAxis" of <me>.

GAx2d GHypr2d.Directrix1 ( )

Computes the directrix which is the line normal to the XAxis of the hyperbola in the local plane (Z = 0) at a distance d = MajorRadius / e from the center of the hyperbola, where e is the eccentricity of the hyperbola. This line is parallel to the "YAxis". The intersection point between the "Directrix1" and the "XAxis" is the "Location" point of the "Directrix1". This point is on the positive side of the "XAxis".

GAx2d GHypr2d.Directrix2 ( )

This line is obtained by the symmetrical transformation of "Directrix1" with respect to the "YAxis" of the hyperbola.

double GHypr2d.Eccentricity ( )

Returns the excentricity of the hyperbola (e > 1). If f is the distance between the location of the hyperbola and the Focus1 then the eccentricity e = f / MajorRadius. Raises DomainError if MajorRadius = 0.0.

double GHypr2d.Focal ( )

Computes the focal distance. It is the distance between the "Location" of the hyperbola and "Focus1" or "Focus2".

GPnt2d GHypr2d.Focus1 ( )

Returns the first focus of the hyperbola. This focus is on the positive side of the "XAxis" of the hyperbola.

GPnt2d GHypr2d.Focus2 ( )

Returns the second focus of the hyperbola. This focus is on the negative side of the "XAxis" of the hyperbola.

boolean GHypr2d.IsDirect ( )

Returns true if the local coordinate system is direct and false in the other case.

GPnt2d GHypr2d.Location ( )

Returns the location point of the hyperbola. It is the intersection point between the "XAxis" and the "YAxis".

double GHypr2d.MajorRadius ( )

Returns the major radius of the hyperbola (it is the radius corresponding to the "XAxis" of the hyperbola).

double GHypr2d.MinorRadius ( )

Returns the minor radius of the hyperbola (it is the radius corresponding to the "YAxis" of the hyperbola).

GHypr2d GHypr2d.Mirrored ( GPnt2d  P)

Performs the symmetrical transformation of an hyperbola with respect to the point P which is the center of the symmetry.

GHypr2d GHypr2d.Mirrored ( GAx2d  A)

Performs the symmetrical transformation of an hyperbola with respect to an axis placement which is the axis of the symmetry.

GHypr2d GHypr2d.OtherBranch ( )

Returns the branch of hyperbola obtained by doing the symmetrical transformation of <me> with respect to the "YAxis" of <me>.

double GHypr2d.Parameter ( )

Returns p = (e * e - 1) * MajorRadius where e is the eccentricity of the hyperbola. Raises DomainError if MajorRadius = 0.0

GHypr2d GHypr2d.Reversed ( )

Reverses the orientation of the local coordinate system of this hyperbola (the "Y Axis" is reversed). Therefore, the implicit orientation of this hyperbola is reversed. Note: - Reverse assigns the result to this hyperbola, while - Reversed creates a new one.

GHypr2d GHypr2d.Rotated ( GPnt2d  P,
double  Ang 
)

Rotates an hyperbola. P is the center of the rotation. Ang is the angular value of the rotation in radians.

GHypr2d GHypr2d.Scaled ( GPnt2d  P,
double  S 
)

Scales an hyperbola. <S> is the scaling value. If <S> is positive only the location point is modified. But if <S> is negative the "XAxis" is reversed and the "YAxis" too.

void GHypr2d.SetAxis ( GAx22d  A)

Modifies this hyperbola, by redefining its local coordinate system so that it becomes A.

void GHypr2d.SetLocation ( GPnt2d  P)

Modifies this hyperbola, by redefining its local coordinate system so that its origin becomes P.

void GHypr2d.SetMajorRadius ( double  MajorRadius)

Modifies the major or minor radius of this hyperbola. Exceptions Standard_ConstructionError if MajorRadius or MinorRadius is negative.

void GHypr2d.SetMinorRadius ( double  MinorRadius)

Modifies the major or minor radius of this hyperbola. Exceptions Standard_ConstructionError if MajorRadius or MinorRadius is negative.

void GHypr2d.SetXAxis ( GAx2d  A)

Changes the major axis of the hyperbola. The minor axis is recomputed and the location of the hyperbola too.

void GHypr2d.SetYAxis ( GAx2d  A)

Changes the minor axis of the hyperbola.The minor axis is recomputed and the location of the hyperbola too.

GHypr2d GHypr2d.Transformed ( GTrsf2d  T)

Transforms an hyperbola with the transformation T from class Trsf2d.

GHypr2d GHypr2d.Translated ( GVec2d  V)

Translates an hyperbola in the direction of the vector V. The magnitude of the translation is the vector's magnitude.

GHypr2d GHypr2d.Translated ( GPnt2d  P1,
GPnt2d  P2 
)

Translates an hyperbola from the point P1 to the point P2.

GAx2d GHypr2d.XAxis ( )

Computes an axis whose - the origin is the center of this hyperbola, and - the unit vector is the "X Direction" or "Y Direction" respectively of the local coordinate system of this hyperbola Returns the major axis of the hyperbola.

GAx2d GHypr2d.YAxis ( )

Computes an axis whose - the origin is the center of this hyperbola, and - the unit vector is the "X Direction" or "Y Direction" respectively of the local coordinate system of this hyperbola Returns the minor axis of the hyperbola.