Back to index

salome-geom  6.5.0
Public Member Functions
GEOM::GEOM_ICurvesOperations Interface Reference

Interface for curves creation. More...

import "GEOM_Gen.idl";

Inheritance diagram for GEOM::GEOM_ICurvesOperations:
Inheritance graph
[legend]
Collaboration diagram for GEOM::GEOM_ICurvesOperations:
Collaboration graph
[legend]

List of all members.

Public Member Functions

GEOM_Object MakeCirclePntVecR (in GEOM_Object thePnt, in GEOM_Object theVec, in double theR)
 Create a circle with given center, normal vector and radius.
GEOM_Object MakeCircleThreePnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2, in GEOM_Object thePnt3)
 Create a circle, passing through three given points.
GEOM_Object MakeCircleCenter2Pnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2, in GEOM_Object thePnt3)
 Create a circle with given center, with a radius equals the distance from center to Point1 and on a plane defined by all of three points.
GEOM_Object MakeEllipse (in GEOM_Object thePnt, in GEOM_Object theVec, in double theRMajor, in double theRMinor)
 Create an ellipse with given center, normal vector and radiuses.
GEOM_Object MakeEllipseVec (in GEOM_Object thePnt, in GEOM_Object theVec, in double theRMajor, in double theRMinor, in GEOM_Object theVecMaj)
 Create an ellipse with given center, normal vector, main axis vector and radiuses.
GEOM_Object MakeArc (in GEOM_Object thePnt1, in GEOM_Object thePnt2, in GEOM_Object thePnt3)
 Create an arc of circle, passing through three given points.
GEOM_Object MakeArcCenter (in GEOM_Object theCenter, in GEOM_Object thePnt1, in GEOM_Object thePnt2, in boolean theSense)
 Create an arc of circle of center C from one point to another.
GEOM_Object MakeArcOfEllipse (in GEOM_Object theCenter, in GEOM_Object thePnt1, in GEOM_Object thePnt2)
 Create an arc of ellipse of center C and two points P1 P2.
GEOM_Object MakePolyline (in ListOfGO thePoints, in boolean theIsClosed)
 Create a polyline on the set of points.
GEOM_Object MakeSplineBezier (in ListOfGO thePoints, in boolean theIsClosed)
 Create bezier curve on the set of points.
GEOM_Object MakeSplineInterpolation (in ListOfGO thePoints, in boolean theIsClosed, in boolean theDoReordering)
 Create B-Spline curve on the set of points.
GEOM_Object MakeCurveParametric (in string thexExpr, in string theyExpr, in string thezExpr, in double theParamMin, in double theParamMax, in double theParamStep, in curve_type theCurveType)
 Creates a curve using the parametric definition of the basic points.
GEOM_Object MakeCurveParametricNew (in string thexExpr, in string theyExpr, in string thezExpr, in double theParamMin, in double theParamMax, in long theParamNbStep, in curve_type theCurveType)
 Creates a curve using the parametric definition of the basic points.
GEOM_Object MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane)
 Create a sketcher (wire or face), following the textual description, passed through theCommand argument.
GEOM_Object Make3DSketcher (in ListOfDouble theCoordinates)
 Create a 3D sketcher, following the numerical description, passed through points created by theCoordinates argument.
GEOM_Object MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane)
 Create a sketcher (wire or face), following the textual description, passed through theCommand argument.
boolean IsDone ()
 To know, if the operation was successfully performed.
void SetErrorCode (in string theErrorID)
 Set the operation error code.
string GetErrorCode ()
 Get the operation error code.
long GetStudyID ()
 Get ID of study, where the operation is defined.
void StartOperation ()
 Opens a new transaction.
void FinishOperation ()
 Closes the previously opened trasaction.
void AbortOperation ()
 Aborts the previously opened transaction.

Detailed Description

Interface for curves creation.

Polyline, Circle, Spline (Bezier and Interpolation)

Definition at line 2600 of file GEOM_Gen.idl.


Member Function Documentation

Aborts the previously opened transaction.

Closes the previously opened trasaction.

string GEOM::GEOM_IOperations::GetErrorCode ( ) [inherited]

Get the operation error code.

long GEOM::GEOM_IOperations::GetStudyID ( ) [inherited]

Get ID of study, where the operation is defined.

boolean GEOM::GEOM_IOperations::IsDone ( ) [inherited]

To know, if the operation was successfully performed.

Create a 3D sketcher, following the numerical description, passed through points created by theCoordinates argument.

Format of the description string have to be the following:

"Make3DSketcher[x1, y1, z1, x2, y2, z2, ..., xN, yN, zN]"

Create an arc of circle, passing through three given points.

Parameters:
thePnt1Start point of the arc.
thePnt2Middle point of the arc.
thePnt3End point of the arc.
Returns:
New GEOM_Object, containing the created arc.
GEOM_Object GEOM::GEOM_ICurvesOperations::MakeArcCenter ( in GEOM_Object  theCenter,
in GEOM_Object  thePnt1,
in GEOM_Object  thePnt2,
in boolean  theSense 
)

Create an arc of circle of center C from one point to another.

Parameters:
theCenterCenter point of the arc.
thePnt1Start point of the arc.
thePnt2End point of the arc.
theSenseOrientation of the arc
Returns:
New GEOM_Object, containing the created arc.

Create an arc of ellipse of center C and two points P1 P2.

Parameters:
theCenterCenter point of the arc.
thePnt1Major radius is distance from center to Pnt1.
thePnt2define a plane and Minor radius as a shortest distance from Pnt2 to vector Center->Pnt1.
Returns:
New GEOM_Object, containing the created arc.

Create a circle with given center, with a radius equals the distance from center to Point1 and on a plane defined by all of three points.

Parameters:
thePnt1,thePnt2,thePnt3Points, defining the circle.
Returns:
New GEOM_Object, containing the created circle.
GEOM_Object GEOM::GEOM_ICurvesOperations::MakeCirclePntVecR ( in GEOM_Object  thePnt,
in GEOM_Object  theVec,
in double  theR 
)

Create a circle with given center, normal vector and radius.

Parameters:
thePntCircle center.
theVecVector, normal to the plane of the circle.
theRCircle radius.
Returns:
New GEOM_Object, containing the created circle.

Create a circle, passing through three given points.

Parameters:
thePnt1,thePnt2,thePnt3Points, defining the circle.
Returns:
New GEOM_Object, containing the created circle.
GEOM_Object GEOM::GEOM_ICurvesOperations::MakeCurveParametric ( in string  thexExpr,
in string  theyExpr,
in string  thezExpr,
in double  theParamMin,
in double  theParamMax,
in double  theParamStep,
in curve_type  theCurveType 
)

Creates a curve using the parametric definition of the basic points.

Parameters:
thexExprparametric equation of the coordinates X.
theyExprparametric equation of the coordinates Y.
thezExprparametric equation of the coordinates Z.
theParamMinthe minimal value of the parameter.
theParamMaxthe maximum value of the parameter.
theParamStepthe step of the parameter.
theCurveTypethe type of the curve.
Returns:
New GEOM_Object, containing the created curve.
GEOM_Object GEOM::GEOM_ICurvesOperations::MakeCurveParametricNew ( in string  thexExpr,
in string  theyExpr,
in string  thezExpr,
in double  theParamMin,
in double  theParamMax,
in long  theParamNbStep,
in curve_type  theCurveType 
)

Creates a curve using the parametric definition of the basic points.

Parameters:
thexExprparametric equation of the coordinates X.
theyExprparametric equation of the coordinates Y.
thezExprparametric equation of the coordinates Z.
theParamMinthe minimal value of the parameter.
theParamMaxthe maximum value of the parameter.
theParamNbStepthe number of steps of the parameter discretization.
theCurveTypethe type of the curve.
Returns:
New GEOM_Object, containing the created curve.
GEOM_Object GEOM::GEOM_ICurvesOperations::MakeEllipse ( in GEOM_Object  thePnt,
in GEOM_Object  theVec,
in double  theRMajor,
in double  theRMinor 
)

Create an ellipse with given center, normal vector and radiuses.

Parameters:
thePntEllipse center.
theVecVector, normal to the plane of the ellipse.
theRMajorMajor ellipse radius.
theRMinorMinor ellipse radius.
Returns:
New GEOM_Object, containing the created ellipse.
GEOM_Object GEOM::GEOM_ICurvesOperations::MakeEllipseVec ( in GEOM_Object  thePnt,
in GEOM_Object  theVec,
in double  theRMajor,
in double  theRMinor,
in GEOM_Object  theVecMaj 
)

Create an ellipse with given center, normal vector, main axis vector and radiuses.

Parameters:
thePntEllipse center.
theVecVector, normal to the plane of the ellipse.
theRMajorMajor ellipse radius.
theRMinorMinor ellipse radius.
theVecMajVector, direction of the ellipse's main axis.
Returns:
New GEOM_Object, containing the created ellipse.
GEOM_Object GEOM::GEOM_ICurvesOperations::MakePolyline ( in ListOfGO  thePoints,
in boolean  theIsClosed 
)

Create a polyline on the set of points.

Parameters:
thePointsSequence of points for the polyline.
theIsClosedIf TRUE, build a closed wire.
Returns:
New GEOM_Object, containing the created polyline.
GEOM_Object GEOM::GEOM_ICurvesOperations::MakeSketcher ( in string  theCommand,
in ListOfDouble  theWorkingPlane 
)

Create a sketcher (wire or face), following the textual description, passed through theCommand argument.

Edges of the resulting wire or face will be arcs of circles and/or linear segments.
Format of the description string have to be the following:

"Sketcher[:F x1 y1]:CMD[:CMD[:CMD...]]"

Where:

  • x1, y1 are coordinates of the first sketcher point (zero by default),
  • CMD is one of
    • "R angle" : Set the direction by angle
    • "D dx dy" : Set the direction by DX & DY

    • "TT x y" : Create segment by point at X & Y
    • "T dx dy" : Create segment by point with DX & DY
    • "L length" : Create segment by direction & Length
    • "IX x" : Create segment by direction & Intersect. X
    • "IY y" : Create segment by direction & Intersect. Y

    • "C radius length" : Create arc by direction, radius and length(in degree)

    • "WW" : Close Wire (to finish)
    • "WF" : Close Wire and build face (to finish)
Parameters:
theCommandString, defining the sketcher in local coordinates of the working plane.
theWorkingPlaneNine double values, defining origin, OZ and OX directions of the working plane.
Returns:
New GEOM_Object, containing the created wire.
GEOM_Object GEOM::GEOM_ICurvesOperations::MakeSketcherOnPlane ( in string  theCommand,
in GEOM_Object  theWorkingPlane 
)

Create a sketcher (wire or face), following the textual description, passed through theCommand argument.

For format of the description string see the previous method.

Parameters:
theCommandString, defining the sketcher in local coordinates of the working plane.
theWorkingPlanePlanar Face or LCS(Marker) of the working plane.
Returns:
New GEOM_Object, containing the created wire.
GEOM_Object GEOM::GEOM_ICurvesOperations::MakeSplineBezier ( in ListOfGO  thePoints,
in boolean  theIsClosed 
)

Create bezier curve on the set of points.

Parameters:
thePointsSequence of points for the bezier curve.
theIsClosedIf TRUE, build a closed curve.
Returns:
New GEOM_Object, containing the created bezier curve.
GEOM_Object GEOM::GEOM_ICurvesOperations::MakeSplineInterpolation ( in ListOfGO  thePoints,
in boolean  theIsClosed,
in boolean  theDoReordering 
)

Create B-Spline curve on the set of points.

Parameters:
thePointsSequence of points for the B-Spline curve.
theIsClosedIf TRUE, build a closed curve.
theDoReorderingIf TRUE, the algo does not follow the order of thePoints but searches for the closest vertex.
Returns:
New GEOM_Object, containing the created B-Spline curve.
void GEOM::GEOM_IOperations::SetErrorCode ( in string  theErrorID) [inherited]

Set the operation error code.

Parameters:
theErrorIDis a string describing the error occured
Note:
This method is supposed to be used only by interfaces inheriting from IOperations.

Opens a new transaction.


The documentation for this interface was generated from the following file: