GEOM.GEOM_ICurvesOperations Interface Reference

import "GEOM_Gen.idl";

Inheritance diagram for GEOM.GEOM_ICurvesOperations:

Public Member Functions
GEOM_Object	MakeCirclePntVecR (in GEOM_Object thePnt, in GEOM_Object theVec, in double theR)
GEOM_Object	MakeCircleThreePnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2, in GEOM_Object thePnt3)
GEOM_Object	MakeCircleCenter2Pnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2, in GEOM_Object thePnt3)
GEOM_Object	MakeEllipse (in GEOM_Object thePnt, in GEOM_Object theVec, in double theRMajor, in double theRMinor)
GEOM_Object	MakeEllipseVec (in GEOM_Object thePnt, in GEOM_Object theVec, in double theRMajor, in double theRMinor, in GEOM_Object theVecMaj)
GEOM_Object	MakeArc (in GEOM_Object thePnt1, in GEOM_Object thePnt2, in GEOM_Object thePnt3)
GEOM_Object	MakeArcCenter (in GEOM_Object theCenter, in GEOM_Object thePnt1, in GEOM_Object thePnt2, in boolean theSense)
GEOM_Object	MakeArcOfEllipse (in GEOM_Object theCenter, in GEOM_Object thePnt1, in GEOM_Object thePnt2)
GEOM_Object	MakePolyline (in ListOfGO thePoints, in boolean theIsClosed)
GEOM_Object	MakeSplineBezier (in ListOfGO thePoints, in boolean theIsClosed)
GEOM_Object	MakeSplineInterpolation (in ListOfGO thePoints, in boolean theIsClosed, in boolean theDoReordering)
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)
GEOM_Object	MakeSketcher (in string theCommand, in ListOfDouble theWorkingPlane)
GEOM_Object	Make3DSketcher (in ListOfDouble theCoordinates)
GEOM_Object	MakeSketcherOnPlane (in string theCommand, in GEOM_Object theWorkingPlane)
boolean	IsDone ()
void	SetErrorCode (in string theErrorID)
string	GetErrorCode ()
long	GetStudyID ()
void	StartOperation ()
void	FinishOperation ()
void	AbortOperation ()

---

Detailed Description

GEOM_ICurvesOperations: Interface for curves creation. Polyline, Circle, Spline (Bezier and Interpolation)

---

Member Function Documentation

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:

thePnt	Circle center.
theVec	Vector, normal to the plane of the circle.
theR	Circle radius.

Returns:

New GEOM_Object, containing the created circle.

GEOM_Object GEOM.GEOM_ICurvesOperations.MakeCircleThreePnt	(	in GEOM_Object	thePnt1,
		in GEOM_Object	thePnt2,
		in GEOM_Object	thePnt3
	)

Create a circle, passing through three given points

Parameters:

thePnt1,thePnt2,thePnt3

Points, defining the circle.

Returns:

New GEOM_Object, containing the created circle.

GEOM_Object GEOM.GEOM_ICurvesOperations.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.

Parameters:

thePnt1,thePnt2,thePnt3

Points, defining the circle.

Returns:

New GEOM_Object, containing the created circle.

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:

thePnt	Ellipse center.
theVec	Vector, normal to the plane of the ellipse.
theRMajor	Major ellipse radius.
theRMinor	Minor 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:

thePnt	Ellipse center.
theVec	Vector, normal to the plane of the ellipse.
theRMajor	Major ellipse radius.
theRMinor	Minor ellipse radius.
theVecMaj	Vector, direction of the ellipse's main axis.

Returns:

New GEOM_Object, containing the created ellipse.

GEOM_Object GEOM.GEOM_ICurvesOperations.MakeArc	(	in GEOM_Object	thePnt1,
		in GEOM_Object	thePnt2,
		in GEOM_Object	thePnt3
	)

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

Parameters:

thePnt1	Start point of the arc.
thePnt2	Middle point of the arc.
thePnt3	End 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:

theCenter	Center point of the arc.
thePnt1	Start point of the arc.
thePnt2	End point of the arc.
theSense	Orientation of the arc

Returns:

New GEOM_Object, containing the created arc.

GEOM_Object GEOM.GEOM_ICurvesOperations.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.

Parameters:

theCenter	Center point of the arc.
thePnt1	Major radius is distance from center to Pnt1.
thePnt2	define a plane and Minor radius as a shortest distance from Pnt2 to vector Center->Pnt1.

Returns:

New GEOM_Object, containing the created arc.

GEOM_Object GEOM.GEOM_ICurvesOperations.MakePolyline	(	in ListOfGO	thePoints,
		in boolean	theIsClosed
	)

Create a polyline on the set of points.

Parameters:

thePoints	Sequence of points for the polyline.
theIsClosed	If TRUE, build a closed wire.

Returns:

New GEOM_Object, containing the created polyline.

GEOM_Object GEOM.GEOM_ICurvesOperations.MakeSplineBezier	(	in ListOfGO	thePoints,
		in boolean	theIsClosed
	)

Create bezier curve on the set of points.

Parameters:

thePoints	Sequence of points for the bezier curve.
theIsClosed	If 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:

thePoints	Sequence of points for the B-Spline curve.
theIsClosed	If TRUE, build a closed curve.
theDoReordering	If 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.

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:

thexExpr	parametric equation of the coordinates X.
theyExpr	parametric equation of the coordinates Y.
thezExpr	parametric equation of the coordinates Z.
theParamMin	the minimal value of the parameter.
theParamMax	the maximum value of the parameter.
theParamStep	the step of the parameter.
theCurveType	the type of the curve.

Returns:

New GEOM_Object, containing the created curve.

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:

theCommand	String, defining the sketcher in local coordinates of the working plane.
theWorkingPlane	Nine 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.Make3DSketcher

(

in ListOfDouble

theCoordinates

)

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]"

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:

theCommand	String, defining the sketcher in local coordinates of the working plane.
theWorkingPlane	Planar Face or LCS(Marker) of the working plane.

Returns:

New GEOM_Object, containing the created wire.

boolean GEOM.GEOM_IOperations.IsDone

(

)

[inherited]

To know, if the operation was successfully performed

void GEOM.GEOM_IOperations.SetErrorCode

(

in string

theErrorID

)

[inherited]

Set the operation error code

Parameters:

theErrorID

is a string describing the error occured

Note:

This method is supposed to be used only by interfaces inheriting from IOperations.

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

void GEOM.GEOM_IOperations.StartOperation

(

)

[inherited]

Opens a new transaction

void GEOM.GEOM_IOperations.FinishOperation

(

)

[inherited]

Closes the previously opened trasaction

void GEOM.GEOM_IOperations.AbortOperation

(

)

[inherited]

Aborts the previously opened transaction