Version: 9.12.0
GEOM::GEOM_IBasicOperations Interface Reference

Interface for basic geometry creation. More...

import"GEOM_Gen.idl";

Inheritance diagram for GEOM::GEOM_IBasicOperations:
Inheritance graph

Public Member Functions

GEOM_Object MakePointXYZ (in double theX, in double theY, in double theZ)
 Create point by three coordinates. More...
 
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. More...
 
GEOM_Object MakePointOnCurve (in GEOM_Object theRefCurve, in double theParameter, in boolean takeOrientationIntoAccount)
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
GEOM_Object MakePointOnFace (in GEOM_Object theFace, in long theNumberOfPnts)
 Create a point, which lays on the given face. The point will lay in arbitrary place of the face. The only condition on it is a non-zero distance to the face boundary. Such point can be used to uniquely identify the face inside any shape in case, when the shape does not contain overlapped faces. More...
 
GEOM_Object MakePointOnLinesIntersection (in GEOM_Object theRefLine1, in GEOM_Object theRefLine2)
 Create a point, on two lines intersection. More...
 
GEOM_Object MakeTangentOnCurve (in GEOM_Object theRefCurve, in double theParameter)
 Create a vector, corresponding to tangent to the given parameter on the given curve. More...
 
GEOM_Object MakeVectorDXDYDZ (in double theDX, in double theDY, in double theDZ)
 Create a vector with the given components. More...
 
GEOM_Object MakeVectorTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2)
 Create a vector between two points. More...
 
GEOM_Object MakeLine (in GEOM_Object thePnt, in GEOM_Object theDir)
 Create a line, passing through the given point and parallel to the given direction. More...
 
GEOM_Object MakeLineTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2)
 Create a line, passing through the given points. More...
 
GEOM_Object MakeLineTwoFaces (in GEOM_Object theFace1, in GEOM_Object theFace2)
 Create a line, given by two faces intersection. More...
 
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. More...
 
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. More...
 
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. More...
 
GEOM_Object MakePlane2Vec (in GEOM_Object theVec1, in GEOM_Object theVec2, in double theTrimSize)
 Create a plane, by two vectors. More...
 
GEOM_Object MakePlaneLCS (in GEOM_Object theLCS, in double theTrimSize, in double theOrientation)
 Create a plane, defined by local coordinate system. More...
 
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. More...
 
GEOM_Object MakeMarkerFromShape (in GEOM_Object theShape)
 Create a local coordinate system from shape. More...
 
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). More...
 
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. More...
 
- Public Member Functions inherited from GEOM::GEOM_IOperations
boolean IsDone ()
 To know, if the operation was successfully performed. More...
 
void SetErrorCode (in string theErrorID)
 Set the operation error code. More...
 
string GetErrorCode ()
 Get the operation error code. More...
 
void StartOperation ()
 Opens a new transaction. More...
 
void FinishOperation ()
 Closes the previously opened transaction. More...
 
void AbortOperation ()
 Aborts the previously opened transaction. More...
 

Detailed Description

(Point, Vector, Plane, Marker)

Member Function Documentation

◆ MakeLine()

GEOM_Object GEOM::GEOM_IBasicOperations::MakeLine ( in GEOM_Object  thePnt,
in GEOM_Object  theDir 
)
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.

◆ MakeLineTwoFaces()

GEOM_Object GEOM::GEOM_IBasicOperations::MakeLineTwoFaces ( in GEOM_Object  theFace1,
in GEOM_Object  theFace2 
)
Parameters
theFace1First of two faces, defining the line.
theFace2Second of two faces, defining the line.
Returns
New GEOM_Object, containing the created line.

◆ MakeLineTwoPnt()

GEOM_Object GEOM::GEOM_IBasicOperations::MakeLineTwoPnt ( in GEOM_Object  thePnt1,
in GEOM_Object  thePnt2 
)
Parameters
thePnt1First of two points, defining the line.
thePnt2Second of two points, defining the line.
Returns
New GEOM_Object, containing the created line.

◆ MakeMarker()

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 
)
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.

◆ MakeMarkerFromShape()

GEOM_Object GEOM::GEOM_IBasicOperations::MakeMarkerFromShape ( in GEOM_Object  theShape)
Parameters
theShapeThe initial shape to detect the coordinate system.
Returns
New GEOM_Object, containing the created coordinate system.

◆ MakeMarkerPntTwoVec()

GEOM_Object GEOM::GEOM_IBasicOperations::MakeMarkerPntTwoVec ( in GEOM_Object  theOrigin,
in GEOM_Object  theXVec,
in GEOM_Object  theYVec 
)
Parameters
theOriginPoint of coordinate system origin.
theXVecVector of X direction.
theYVecVector of Y direction.
Returns
New GEOM_Object, containing the created coordinate system.

◆ MakePlane2Vec()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePlane2Vec ( in GEOM_Object  theVec1,
in GEOM_Object  theVec2,
in double  theTrimSize 
)
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.

◆ MakePlaneFace()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePlaneFace ( in GEOM_Object  theFace,
in double  theTrimSize 
)
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.

◆ MakePlaneLCS()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePlaneLCS ( in GEOM_Object  theLCS,
in double  theTrimSize,
in double  theOrientation 
)
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.

◆ MakePlanePntVec()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePlanePntVec ( in GEOM_Object  thePnt,
in GEOM_Object  theVec,
in double  theTrimSize 
)
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.

◆ MakePlaneThreePnt()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePlaneThreePnt ( in GEOM_Object  thePnt1,
in GEOM_Object  thePnt2,
in GEOM_Object  thePnt3,
in double  theTrimSize 
)
Parameters
thePnt1First of three points, defining the plane.
thePnt2Second of three points, defining the plane.
thePnt3Third 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.

◆ MakePointOnCurve()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePointOnCurve ( in GEOM_Object  theRefCurve,
in double  theParameter,
in boolean  takeOrientationIntoAccount 
)

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

Parameters
theRefCurveThe referenced curve.
theParameterValue of parameter on the referenced curve.
takeOrientationIntoAccountflag that tells if it is necessary to take the curve's orientation into account.
Returns
New GEOM_Object, containing the created point.

◆ MakePointOnCurveByCoord()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePointOnCurveByCoord ( in GEOM_Object  theRefCurve,
in double  theXParameter,
in double  theYParameter,
in double  theZParameter 
)
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.

◆ MakePointOnCurveByLength()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePointOnCurveByLength ( in GEOM_Object  theRefCurve,
in double  theLength,
in GEOM_Object  theStartPoint 
)
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.

◆ MakePointOnFace()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePointOnFace ( in GEOM_Object  theFace,
in long  theNumberOfPnts 
)
Parameters
theFaceThe referenced face.
Returns
New GEOM_Object, containing the created point.

◆ MakePointOnLinesIntersection()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePointOnLinesIntersection ( in GEOM_Object  theRefLine1,
in GEOM_Object  theRefLine2 
)
Parameters
theRefLine1,theRefLine2The referenced lines.
Returns
New GEOM_Object, containing the created point.

◆ MakePointOnSurface()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePointOnSurface ( in GEOM_Object  theRefSurf,
in double  theUParameter,
in double  theVParameter 
)
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.

◆ MakePointOnSurfaceByCoord()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePointOnSurfaceByCoord ( in GEOM_Object  theRefSurf,
in double  theXParameter,
in double  theYParameter,
in double  theZParameter 
)
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.

◆ MakePointWithReference()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePointWithReference ( in GEOM_Object  theReference,
in double  theX,
in double  theY,
in double  theZ 
)
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.

◆ MakePointXYZ()

GEOM_Object GEOM::GEOM_IBasicOperations::MakePointXYZ ( in double  theX,
in double  theY,
in double  theZ 
)
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.

◆ MakeTangentOnCurve()

GEOM_Object GEOM::GEOM_IBasicOperations::MakeTangentOnCurve ( in GEOM_Object  theRefCurve,
in double  theParameter 
)
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.

◆ MakeTangentPlaneOnFace()

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

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.

◆ MakeVectorDXDYDZ()

GEOM_Object GEOM::GEOM_IBasicOperations::MakeVectorDXDYDZ ( in double  theDX,
in double  theDY,
in double  theDZ 
)
Parameters
theDXX component of the vector.
theDYY component of the vector.
theDZZ component of the vector.
Returns
New GEOM_Object, containing the created vector.

◆ MakeVectorTwoPnt()

GEOM_Object GEOM::GEOM_IBasicOperations::MakeVectorTwoPnt ( in GEOM_Object  thePnt1,
in GEOM_Object  thePnt2 
)
Parameters
thePnt1Start point for the vector.
thePnt2End point for the vector.
Returns
New GEOM_Object, containing the created vector.

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