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

Public Member Functions

synchronized void delete ()
 
 GHypr ()
 
 GHypr (GAx2 A2, double MajorRadius, double MinorRadius)
 
void SetAxis (GAx1 A1)
 
void SetLocation (GPnt P)
 
void SetMajorRadius (double MajorRadius)
 
void SetMinorRadius (double MinorRadius)
 
void SetPosition (GAx2 A2)
 
GAx1 Asymptote1 ()
 
GAx1 Asymptote2 ()
 
GAx1 Axis ()
 
GHypr ConjugateBranch1 ()
 
GHypr ConjugateBranch2 ()
 
GAx1 Directrix1 ()
 
GAx1 Directrix2 ()
 
double Eccentricity ()
 
double Focal ()
 
GPnt Focus1 ()
 
GPnt Focus2 ()
 
GPnt Location ()
 
double MajorRadius ()
 
double MinorRadius ()
 
GHypr OtherBranch ()
 
double Parameter ()
 
GAx2 Position ()
 
GAx1 XAxis ()
 
GAx1 YAxis ()
 
void Mirror (GPnt P)
 
GHypr Mirrored (GPnt P)
 
void Mirror (GAx1 A1)
 
GHypr Mirrored (GAx1 A1)
 
void Mirror (GAx2 A2)
 
GHypr Mirrored (GAx2 A2)
 
void Rotate (GAx1 A1, double Ang)
 
GHypr Rotated (GAx1 A1, double Ang)
 
void Scale (GPnt P, double S)
 
GHypr Scaled (GPnt P, double S)
 
void Transform (GTrsf T)
 
GHypr Transformed (GTrsf T)
 
void Translate (GVec V)
 
GHypr Translated (GVec V)
 
void Translate (GPnt P1, GPnt P2)
 
GHypr Translated (GPnt P1, GPnt P2)
 

Protected Member Functions

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

Static Protected Member Functions

static long getCPtr (GHypr obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

Describes a branch of a hyperbola in 3D space. A hyperbola is defined by its major and minor radii and positioned in space with a coordinate system (a gp_Ax2 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. The origin, "X Direction" and "Y Direction" of this coordinate system together define the plane of the hyperbola. This coordinate system is the "local coordinate system" of 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 "main Direction" of the local coordinate system is a normal vector to the plane of the hyperbola. This vector gives an implicit orientation to the hyperbola. We refer to the "main Axis" of the local coordinate system as the "Axis" of the hyperbola. 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 | ^YAxis Warning The major radius can be less than the minor radius. See Also gce_MakeHypr which provides functions for more complex hyperbola constructions Geom_Hyperbola which provides additional functions for constructing hyperbolas and works, in particular, with the parametric equations of hyperbolas

Constructor & Destructor Documentation

GHypr.GHypr ( )

Creates of an indefinite hyperbola.

GHypr.GHypr ( GAx2  A2,
double  MajorRadius,
double  MinorRadius 
)

Creates a hyperbola with radii MajorRadius and MinorRadius, positioned in the space by the coordinate system A2 such that: - the origin of A2 is the center of the hyperbola, - the "X Direction" of A2 defines the major axis of the hyperbola, that is, the major radius MajorRadius is measured along this axis, and - the "Y Direction" of A2 defines the minor axis of the hyperbola, that is, the minor radius MinorRadius is measured along this axis. Note: This class does not prevent the creation of a hyperbola where: - MajorAxis is equal to MinorAxis, or - MajorAxis is less than MinorAxis. Exceptions Standard_ConstructionError if MajorAxis or MinorAxis is negative. Raises ConstructionError if MajorRadius < 0.0 or MinorRadius < 0.0 Raised if MajorRadius < 0.0 or MinorRadius < 0.0

Member Function Documentation

GAx1 GHypr.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 and B is the minor radius. Raises ConstructionError if MajorRadius = 0.0

GAx1 GHypr.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 and B is the minor radius. Raises ConstructionError if MajorRadius = 0.0

GAx1 GHypr.Axis ( )

Returns the axis passing through the center, and normal to the plane of this hyperbola.

GHypr GHypr.ConjugateBranch1 ( )

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

GHypr GHypr.ConjugateBranch2 ( )

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

GAx1 GHypr.Directrix1 ( )

This directrix 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".

GAx1 GHypr.Directrix2 ( )

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

double GHypr.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 GHypr.Focal ( )

Computes the focal distance. It is the distance between the the two focus of the hyperbola.

GPnt GHypr.Focus1 ( )

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

GPnt GHypr.Focus2 ( )

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

GPnt GHypr.Location ( )

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

double GHypr.MajorRadius ( )

Returns the major radius of the hyperbola. It is the radius on the "XAxis" of the hyperbola.

double GHypr.MinorRadius ( )

Returns the minor radius of the hyperbola. It is the radius on the "YAxis" of the hyperbola.

GHypr GHypr.Mirrored ( GPnt  P)

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

GHypr GHypr.Mirrored ( GAx1  A1)

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

GHypr GHypr.Mirrored ( GAx2  A2)

Performs the symmetrical transformation of an hyperbola with respect to a plane. The axis placement A2 locates the plane of the symmetry (Location, XDirection, YDirection).

GHypr GHypr.OtherBranch ( )

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

double GHypr.Parameter ( )

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

GAx2 GHypr.Position ( )

Returns the coordinate system of the hyperbola.

GHypr GHypr.Rotated ( GAx1  A1,
double  Ang 
)

Rotates an hyperbola. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians.

GHypr GHypr.Scaled ( GPnt  P,
double  S 
)

Scales an hyperbola. S is the scaling value.

void GHypr.SetAxis ( GAx1  A1)

Modifies this hyperbola, 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 in the same way as for any gp_Ax2). Raises ConstructionError if the direction of A1 is parallel to the direction of the "XAxis" of the hyperbola.

void GHypr.SetLocation ( GPnt  P)

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

void GHypr.SetMajorRadius ( double  MajorRadius)

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

void GHypr.SetMinorRadius ( double  MinorRadius)

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

void GHypr.SetPosition ( GAx2  A2)

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

GHypr GHypr.Transformed ( GTrsf  T)

Transforms an hyperbola with the transformation T from class Trsf.

GHypr GHypr.Translated ( GVec  V)

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

GHypr GHypr.Translated ( GPnt  P1,
GPnt  P2 
)

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

GAx1 GHypr.XAxis ( )

Computes an axis, whose - the origin is the center of this hyperbola, and - the unit vector is the "X Direction" of the local coordinate system of this hyperbola. These axes are, the major axis (the "X Axis") and of this hyperboReturns the "XAxis" of the hyperbola.

GAx1 GHypr.YAxis ( )

Computes an axis, whose - the origin is the center of this hyperbola, and - the unit vector is the "Y Direction" of the local coordinate system of this hyperbola. These axes are the minor axis (the "Y Axis") of this hyperbola