Back to index

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

Interface for basic geometry creation. More...

import "GEOM_Gen.idl";

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

List of all members.

Public Member Functions

GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ)
 Create point by three coordinates.
GEOM_Object 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.
GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve, in double theParameter)
 Create a point, corresponding to the given parameter on the given curve.
GEOM_Object MakePointOnCurveByLength (in GEOM_Object theRefCurve, in double theLength, in GEOM_Object theStartPoint)
 Create a point, corresponding to the given length on the given curve.
GEOM_Object MakePointOnCurveByCoord (in GEOM_Object theRefCurve, in double theXParameter, in double theYParameter, in double theZParameter)
 Create a point on the given curve, projecting given point.
GEOM_Object MakePointOnSurface (in GEOM_Object theRefSurf, in double theUParameter, in double theVParameter)
 Create a point, corresponding to the given parameters on the given surface.
GEOM_Object MakePointOnSurfaceByCoord (in GEOM_Object theRefSurf, in double theXParameter, in double theYParameter, in double theZParameter)
 Create a point on the given surface, projecting given point.
GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1, in GEOM_Object theRefLine2)
 Create a point, on two lines intersection.
GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve, in double theParameter)
 Create a vector, corresponding to tangent to the given parameter on the given curve.
GEOM_Object MakeVectorDXDYDZ (in double theDX, in double theDY, in double theDZ)
 Create a vector with the given components.
GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2)
 Create a vector between two points.
GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir)
 C.
GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2)
 Create a line, passing through the given points.
GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2)
 Create a line, given by two faces intersection.
GEOM_Object 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.
GEOM_Object 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.
GEOM_Object MakePlaneFace (in GEOM_Object theFace, in double theTrimSize)
 Create a plane, similar to the existing one, but with another size of representing face.
GEOM_Object MakePlane2Vec (in GEOM_Object theVec1, in GEOM_Object theVec2, in double theTrimSize)
 Create a plane, by two vectors.
GEOM_Object MakePlaneLCS (in GEOM_Object theLCS, in double theTrimSize, in double theOrientation)
 Create a plane, defined by local coordinate system.
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)
 Create a local coordinate system.
GEOM_Object MakeMarkerFromShape (in GEOM_Object theShape)
 Create a local coordinate system from shape.
GEOM_Object 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).
GEOM_Object 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.
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 basic geometry creation.

(Point, Vector, Plane, Marker)

Definition at line 447 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.

C.

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

Parameters:
thePntPoint. The resulting line will pass through it.
theDirDirection. The resulting line will be parallel to it.
Returns:
New GEOM_Object, containing the created line.

Here is the caller graph for this function:

Create a line, given by two faces intersection.

Parameters:
theFace1First of two faces, defining the line.
theFace2Second of two faces, defining the line.
Returns:
New GEOM_Object, containing the created line.

Create a line, passing through the given points.

Parameters:
thePnt1First of two points, defining the line.
thePnt2Second of two points, defining the line.
Returns:
New GEOM_Object, containing the created line.
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,theOZThree coordinates of coordinate system origin.
theXDX,theXDY,theXDZThree components of OX direction
theYDX,theYDY,theYDZThree components of OY direction
Returns:
New GEOM_Object, containing the created coordinate system.

Create a local coordinate system from shape.

Parameters:
theShapeThe initial shape to detect the coordinate system.
Returns:
New GEOM_Object, containing the created coordinate system.

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

Parameters:
theOriginPoint of coordinate system origin.
theXVecVector of X direction.
theYVecVector of Y direction.
Returns:
New GEOM_Object, containing the created coordinate system.
GEOM_Object GEOM::GEOM_IBasicOperations::MakePlane2Vec ( in GEOM_Object  theVec1,
in GEOM_Object  theVec2,
in double  theTrimSize 
)

Create a plane, by two vectors.

Parameters:
theVec1Vector1, the plane has to pass through first point of this vector.
theVec2Vector2, defining the plane normal direction.
theTrimSizeHalf 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:
theFaceReferenced plane or LCS(Marker).
theTrimSizeNew 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:
theLCSReferenced LCS(Marker).
theTrimSizeHalf size of a side of quadrangle face, representing the plane.
theOrientationOXY, OYZ or OZX orientation = (1, 2 or 3).
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:
thePntPoint, the plane has to pass through.
theVecVector, defining the plane normal direction.
theTrimSizeHalf size of a side of quadrangle face, representing the plane.
Returns:
New GEOM_Object, containing the created plane.
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:
thePnt1First of three points, defining the plane.
thePnt2Second of three points, defining the plane.
thePnt3Fird of three points, defining the plane.
theTrimSizeHalf size of a side of quadrangle face, representing the plane.
Returns:
New GEOM_Object, containing the created plane.
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:
theRefCurveThe referenced curve.
theParameterValue of parameter on the referenced curve.
Returns:
New GEOM_Object, containing the created point.
GEOM_Object GEOM::GEOM_IBasicOperations::MakePointOnCurveByCoord ( in GEOM_Object  theRefCurve,
in double  theXParameter,
in double  theYParameter,
in double  theZParameter 
)

Create a point on the given curve, projecting given point.

Parameters:
theRefCurveThe referenced curve.
theXParameterX co-ordinate of point to project on curve
theYParameterY co-ordinate of point to project on curve
theZParameterZ co-ordinate of point to project on 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:
theRefCurveThe referenced curve.
theLengthLength on the referenced curve. It can be negative.
theStartPointAny 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.

Create a point, on two lines intersection.

Parameters:
theRefLine1,theRefLine2The referenced lines.
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:
theRefSurfThe referenced surface.
theUParameterValue of U-parameter on the referenced surface.
theVParameterValue 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  theYParameter,
in double  theZParameter 
)

Create a point on the given surface, projecting given point.

Parameters:
theRefSurfThe referenced surface.
theXParameterX co-ordinate of point to project on curve
theYParameterY co-ordinate of point to project on curve
theZParameterZ co-ordinate of point to project on curve
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:
theReferenceThe referenced point.
theXDisplacement from the referenced point along OX axis.
theYDisplacement from the referenced point along OY axis.
theZDisplacement from the referenced point along OZ axis.
Returns:
New GEOM_Object, containing the created point.
GEOM_Object GEOM::GEOM_IBasicOperations::MakePointXYZ ( in double  theX,
in double  theY,
in double  theZ 
)

Create point by three coordinates.

Parameters:
theXThe X coordinate of the point.
theYThe Y coordinate of the point.
theZThe Z coordinate of the point.
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:
theRefCurveThe referenced curve.
theParameterValue of parameter on the referenced curve.This value should be have value between 0. and 1.. Value of 0. corresponds first parameter of curve; value
  1. corresponds last parameter of curve.
Returns:
New GEOM_Object, containing the created point.
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.
GEOM_Object GEOM::GEOM_IBasicOperations::MakeVectorDXDYDZ ( in double  theDX,
in double  theDY,
in double  theDZ 
)

Create a vector with the given components.

Parameters:
theDXX component of the vector.
theDYY component of the vector.
theDZZ component of the vector.
Returns:
New GEOM_Object, containing the created vector.

Create a vector between two points.

Parameters:
thePnt1Start point for the vector.
thePnt2End point for the vector.
Returns:
New GEOM_Object, containing the created vector.
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: