GEOM.GEOM_IBasicOperations Interface Reference

import "GEOM_Gen.idl";

Inheritance diagram for GEOM.GEOM_IBasicOperations:

Public Member Functions
GEOM_Object	MakePointXYZ (in double theX, in double theY, in double theZ)
GEOM_Object	MakePointWithReference (in GEOM_Object theReference, in double theX, in double theY, in double theZ)
GEOM_Object	MakePointOnCurve (in GEOM_Object theRefCurve, in double theParameter)
GEOM_Object	MakePointOnCurveByLength (in GEOM_Object theRefCurve, in double theLength, in GEOM_Object theStartPoint)
GEOM_Object	MakePointOnCurveByCoord (in GEOM_Object theRefCurve, in double theXParameter, in double theYarameter, in double theZPameter)
GEOM_Object	MakePointOnSurface (in GEOM_Object theRefSurf, in double theUParameter, in double theVParameter)
GEOM_Object	MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf, in double theXParameter, in double theYarameter, in double theZPameter)
GEOM_Object	MakePointOnLinesIntersection (in GEOM_Object theRefLine1, in GEOM_Object theRefLine2)
GEOM_Object	MakeTangentOnCurve (in GEOM_Object theRefCurve, in double theParameter)
GEOM_Object	MakeVectorDXDYDZ (in double theDX, in double theDY, in double theDZ)
GEOM_Object	MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2)
GEOM_Object	MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir)
GEOM_Object	MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2)
GEOM_Object	MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2)
GEOM_Object	MakePlaneThreePnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2, in GEOM_Object thePnt3, in double theTrimSize)
GEOM_Object	MakePlanePntVec (in GEOM_Object thePnt, in GEOM_Object theVec, in double theTrimSize)
GEOM_Object	MakePlaneFace (in GEOM_Object theFace, in double theTrimSize)
GEOM_Object	MakePlane2Vec (in GEOM_Object theVec1, in GEOM_Object theVec2, in double theTrimSize)
GEOM_Object	MakePlaneLCS (in GEOM_Object theLCS, in double theTrimSize, in double theOrientation)
GEOM_Object	MakeMarker (in double theOX, in double theOY, in double theOZ, in double theXDX, in double theXDY, in double theXDZ, in double theYDX, in double theYDY, in double theYDZ)
GEOM_Object	MakeMarkerFromShape (in GEOM_Object theShape)
GEOM_Object	MakeMarkerPntTwoVec (in GEOM_Object theOrigin, in GEOM_Object theXVec, in GEOM_Object theYVec)
GEOM_Object	MakeTangentPlaneOnFace (in GEOM_Object theFace, in double theParameterU, in double theParameterV, in double theTrimSize)
boolean	IsDone ()
void	SetErrorCode (in string theErrorID)
string	GetErrorCode ()
long	GetStudyID ()
void	StartOperation ()
void	FinishOperation ()
void	AbortOperation ()

---

Detailed Description

GEOM_IBasicOperations: interface for basic geometry creation (Point, Vector, Plane, Marker)

---

Member Function Documentation

GEOM_Object GEOM.GEOM_IBasicOperations.MakePointXYZ	(	in double	theX,
		in double	theY,
		in double	theZ
	)

Create point by three coordinates.

Parameters:

theX	The X coordinate of the point.
theY	The Y coordinate of the point.
theZ	The Z coordinate of the point.

Returns:

New GEOM_Object, containing the created point.

GEOM_Object GEOM.GEOM_IBasicOperations.MakePointWithReference	(	in GEOM_Object	theReference,
		in double	theX,
		in double	theY,
		in double	theZ
	)

Create a point, distant from the referenced point on the given distances along the coordinate axes.

Parameters:

theReference	The referenced point.
theX	Displacement from the referenced point along OX axis.
theY	Displacement from the referenced point along OY axis.
theZ	Displacement from the referenced point along OZ axis.

Returns:

New GEOM_Object, containing the created point.

GEOM_Object GEOM.GEOM_IBasicOperations.MakePointOnCurve	(	in GEOM_Object	theRefCurve,
		in double	theParameter
	)

Create a point, corresponding to the given parameter on the given curve.

Parameters:

theRefCurve	The referenced curve.
theParameter	Value of parameter on the referenced curve.

Returns:

New GEOM_Object, containing the created point.

GEOM_Object GEOM.GEOM_IBasicOperations.MakePointOnCurveByLength	(	in GEOM_Object	theRefCurve,
		in double	theLength,
		in GEOM_Object	theStartPoint
	)

Create a point, corresponding to the given length on the given curve.

Parameters:

theRefCurve	The referenced curve.
theLength	Length on the referenced curve. It can be negative.
theStartPoint	Any vertex close to one of edge's ends to select start point among them. If NULL, fist vertex is used.

Returns:

New GEOM_Object, containing the created point.

GEOM_Object GEOM.GEOM_IBasicOperations.MakePointOnCurveByCoord	(	in GEOM_Object	theRefCurve,
		in double	theXParameter,
		in double	theYarameter,
		in double	theZPameter
	)

Create a point on the given curve, projecting given point

Parameters:

theRefCurve	The referenced curve.
theXParameter	X co-ordinate of point to project on curve
theYParameter	Y co-ordinate of point to project on curve
theZParameter	Z co-ordinate of point to project on curve

Returns:

New GEOM_Object, containing the created point.

GEOM_Object GEOM.GEOM_IBasicOperations.MakePointOnSurface	(	in GEOM_Object	theRefSurf,
		in double	theUParameter,
		in double	theVParameter
	)

Create a point, corresponding to the given parameters on the given surface.

Parameters:

theRefSurf	The referenced surface.
theUParameter	Value of U-parameter on the referenced surface.
theVParameter	Value of V-parameter on the referenced surface.

Returns:

New GEOM_Object, containing the created point.

GEOM_Object GEOM.GEOM_IBasicOperations.MakePointOnSurfaceByCoord	(	in GEOM_Object	theRefSurf,
		in double	theXParameter,
		in double	theYarameter,
		in double	theZPameter
	)

Create a point on the given surface, projecting given point

Parameters:

theRefSurf	The referenced surface.
theXParameter	X co-ordinate of point to project on curve
theYParameter	Y co-ordinate of point to project on curve
theZParameter	Z co-ordinate of point to project on curve

Returns:

New GEOM_Object, containing the created point.

GEOM_Object GEOM.GEOM_IBasicOperations.MakePointOnLinesIntersection	(	in GEOM_Object	theRefLine1,
		in GEOM_Object	theRefLine2
	)

Create a point, on two lines intersection.

Parameters:

theRefLine1,theRefLine2

The referenced lines.

Returns:

New GEOM_Object, containing the created point.

GEOM_Object GEOM.GEOM_IBasicOperations.MakeTangentOnCurve	(	in GEOM_Object	theRefCurve,
		in double	theParameter
	)

Create a vector, corresponding to tangent to the given parameter on the given curve.

Parameters:

theRefCurve	The referenced curve.
theParameter	Value of parameter on the referenced curve.This value should be have value 0. and 1.. Value of 0. corresponds first parameter of curve value 1. corresponds parameter of curve.

Returns:

New GEOM_Object, containing the created point.

GEOM_Object GEOM.GEOM_IBasicOperations.MakeVectorDXDYDZ	(	in double	theDX,
		in double	theDY,
		in double	theDZ
	)

Create a vector with the given components.

Parameters:

theDX	X component of the vector.
theDY	Y component of the vector.
theDZ	Z component of the vector.

Returns:

New GEOM_Object, containing the created vector.

GEOM_Object GEOM.GEOM_IBasicOperations.MakeVectorTwoPnt	(	in GEOM_Object	thePnt1,
		in GEOM_Object	thePnt2
	)

Create a vector between two points.

Parameters:

thePnt1	Start point for the vector.
thePnt2	End point for the vector.

Returns:

New GEOM_Object, containing the created vector.

GEOM_Object GEOM.GEOM_IBasicOperations.MakeLine	(	in GEOM_Object	thePnt,
		in GEOM_Object	theDir
	)

Create a line, passing through the given point and parrallel to the given direction

Parameters:

thePnt	Point. The resulting line will pass through it.
theDir	Direction. The resulting line will be parallel to it.

Returns:

New GEOM_Object, containing the created line.

GEOM_Object GEOM.GEOM_IBasicOperations.MakeLineTwoPnt	(	in GEOM_Object	thePnt1,
		in GEOM_Object	thePnt2
	)

Create a line, passing through the given points

Parameters:

thePnt1	First of two points, defining the line.
thePnt2	Second of two points, defining the line.

Returns:

New GEOM_Object, containing the created line.

GEOM_Object GEOM.GEOM_IBasicOperations.MakeLineTwoFaces	(	in GEOM_Object	theFace1,
		in GEOM_Object	theFace2
	)

Create a line, given by two faces intersection.

Parameters:

theFace1	First of two faces, defining the line.
theFace2	Second of two faces, defining the line.

Returns:

New GEOM_Object, containing the created line.

GEOM_Object GEOM.GEOM_IBasicOperations.MakePlaneThreePnt	(	in GEOM_Object	thePnt1,
		in GEOM_Object	thePnt2,
		in GEOM_Object	thePnt3,
		in double	theTrimSize
	)

Create a plane, passing through the three given points

Parameters:

thePnt1	First of three points, defining the plane.
thePnt2	Second of three points, defining the plane.
thePnt3	Fird of three points, defining the plane.
theTrimSize	Half size of a side of quadrangle face, representing the plane.

Returns:

New GEOM_Object, containing the created plane.

GEOM_Object GEOM.GEOM_IBasicOperations.MakePlanePntVec	(	in GEOM_Object	thePnt,
		in GEOM_Object	theVec,
		in double	theTrimSize
	)

Create a plane, passing through the given point and normal to the given vector.

Parameters:

thePnt	Point, the plane has to pass through.
theVec	Vector, defining the plane normal direction.
theTrimSize	Half size of a side of quadrangle face, representing the plane.

Returns:

New GEOM_Object, containing the created plane.

GEOM_Object GEOM.GEOM_IBasicOperations.MakePlaneFace	(	in GEOM_Object	theFace,
		in double	theTrimSize
	)

Create a plane, similar to the existing one, but with another size of representing face.

Parameters:

theFace	Referenced plane or LCS(Marker).
theTrimSize	New half size of a side of quadrangle face, representing the plane.

Returns:

New GEOM_Object, containing the created plane.

GEOM_Object GEOM.GEOM_IBasicOperations.MakePlane2Vec	(	in GEOM_Object	theVec1,
		in GEOM_Object	theVec2,
		in double	theTrimSize
	)

Create a plane, by two vectors.

Parameters:

theVec1	Vector1, the plane has to pass through first point of this vector.
theVec	Vector2, defining the plane normal direction.
theTrimSize	Half size of a side of quadrangle face, representing the plane.

Returns:

New GEOM_Object, containing the created plane.

GEOM_Object GEOM.GEOM_IBasicOperations.MakePlaneLCS	(	in GEOM_Object	theLCS,
		in double	theTrimSize,
		in double	theOrientation
	)

Create a plane, defined by local coordinate system.

Parameters:

theLCS	Referenced LCS(Marker).
theTrimSize	Half size of a side of quadrangle face, representing the plane.
theOrientation	OXY, OYZ or OZX orientation = (1, 2 or 3).

Returns:

New GEOM_Object, containing the created plane.

GEOM_Object GEOM.GEOM_IBasicOperations.MakeMarker	(	in double	theOX,
		in double	theOY,
		in double	theOZ,
		in double	theXDX,
		in double	theXDY,
		in double	theXDZ,
		in double	theYDX,
		in double	theYDY,
		in double	theYDZ
	)

Create a local coordinate system.

Parameters:

theOX,theOY,theOZ	Three coordinates of coordinate system origin.
theXDX,theXDY,theXDZ	Three components of OX direction
theYDX,theYDY,theYDZ	Three components of OY direction

Returns:

New GEOM_Object, containing the created coordinate system.

GEOM_Object GEOM.GEOM_IBasicOperations.MakeMarkerFromShape

(

in GEOM_Object

theShape

)

Create a local coordinate system from shape.

Parameters:

theShape

The initial shape to detect the coordinate system.

Returns:

New GEOM_Object, containing the created coordinate system.

GEOM_Object GEOM.GEOM_IBasicOperations.MakeMarkerPntTwoVec	(	in GEOM_Object	theOrigin,
		in GEOM_Object	theXVec,
		in GEOM_Object	theYVec
	)

Create a local coordinate system from point and two vectors (DX, DY).

Parameters:

theOrigin	Point of coordinate system origin.
theXVec	Vector of X direction.
theYVec	Vector of Y direction.

Returns:

New GEOM_Object, containing the created coordinate system.

GEOM_Object GEOM.GEOM_IBasicOperations.MakeTangentPlaneOnFace	(	in GEOM_Object	theFace,
		in double	theParameterU,
		in double	theParameterV,
		in double	theTrimSize
	)

Create a tangent plane to specified face in the point with specified parameters. Values of parameters should be between 0. and 1.0

Parameters:

theFace	- face for which tangent plane shuold be built.
theParameterU	- value of parameter by U
theParameterV	- value of parameter Vthe
theTrimSize	- defines sizes of created face

Returns:

New GEOM_Object, containing the face built on tangent plane.

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