GEOM.GEOM_I3DPrimOperations Interface Reference

import "GEOM_Gen.idl";

Inheritance diagram for GEOM.GEOM_I3DPrimOperations:

Public Member Functions
GEOM_Object	MakeBoxDXDYDZ (in double theDX, in double theDY, in double theDZ)
GEOM_Object	MakeBoxTwoPnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2)
GEOM_Object	MakeFaceHW (in double theH, in double theW, in short theOrientation)
GEOM_Object	MakeFaceObjHW (in GEOM_Object theObj, in double theH, in double theW)
GEOM_Object	MakeDiskPntVecR (in GEOM_Object thePnt, in GEOM_Object theVec, in double theR)
GEOM_Object	MakeDiskThreePnt (in GEOM_Object thePnt1, in GEOM_Object thePnt2, in GEOM_Object thePnt3)
GEOM_Object	MakeDiskR (in double theR, in short theOrientation)
GEOM_Object	MakeCylinderRH (in double theR, in double theH)
GEOM_Object	MakeCylinderPntVecRH (in GEOM_Object thePnt, in GEOM_Object theAxis, in double theR, in double theH)
GEOM_Object	MakeConeR1R2H (in double theR1, in double theR2, in double theH)
GEOM_Object	MakeConePntVecR1R2H (in GEOM_Object thePnt, in GEOM_Object theAxis, in double theR1, in double theR2, in double theH)
GEOM_Object	MakeTorusRR (in double theRMajor, in double theRMinor)
GEOM_Object	MakeTorusPntVecRR (in GEOM_Object thePnt, in GEOM_Object theVec, in double theRMajor, in double theRMinor)
GEOM_Object	MakeSphereR (in double theR)
GEOM_Object	MakeSpherePntR (in GEOM_Object thePnt, in double theR)
GEOM_Object	MakePrismVecH (in GEOM_Object theBase, in GEOM_Object theVec, in double theH)
GEOM_Object	MakePrismVecH2Ways (in GEOM_Object theBase, in GEOM_Object theVec, in double theH)
GEOM_Object	MakePrismVecHWithScaling (in GEOM_Object theBase, in GEOM_Object theVec, in double theH, in double theScaleFactor)
GEOM_Object	MakePrismTwoPnt (in GEOM_Object theBase, in GEOM_Object thePoint1, in GEOM_Object thePoint2)
GEOM_Object	MakePrismTwoPnt2Ways (in GEOM_Object theBase, in GEOM_Object thePoint1, in GEOM_Object thePoint2)
GEOM_Object	MakePrismTwoPntWithScaling (in GEOM_Object theBase, in GEOM_Object thePoint1, in GEOM_Object thePoint2, in double theScaleFactor)
GEOM_Object	MakePrismDXDYDZ (in GEOM_Object theBase, in double theDX, in double theDY, in double theDZ)
GEOM_Object	MakePrismDXDYDZ2Ways (in GEOM_Object theBase, in double theDX, in double theDY, in double theDZ)
GEOM_Object	MakePrismDXDYDZWithScaling (in GEOM_Object theBase, in double theDX, in double theDY, in double theDZ, in double theScaleFactor)
GEOM_Object	MakePipe (in GEOM_Object theBase, in GEOM_Object thePath)
GEOM_Object	MakeRevolutionAxisAngle (in GEOM_Object theBase, in GEOM_Object theAxis, in double theAngle)
GEOM_Object	MakeRevolutionAxisAngle2Ways (in GEOM_Object theBase, in GEOM_Object theAxis, in double theAngle)
GEOM_Object	MakeFilling (in GEOM_Object theShape, in long theMinDeg, in long theMaxDeg, in double theTol2D, in double theTol3D, in long theNbIter, in filling_oper_method theMethod, in boolean theApprox)
GEOM_Object	MakeThruSections (in ListOfGO theSeqSections, in boolean theModeSolid, in double thePreci, in boolean theRuled)
GEOM_Object	MakePipeWithDifferentSections (in ListOfGO theSeqBases, in ListOfGO theLocations, in GEOM_Object thePath, in boolean theWithContact, in boolean theWithCorrection)
GEOM_Object	MakePipeWithShellSections (in ListOfGO theSeqBases, in ListOfGO theSeqSubBases, in ListOfGO theLocations, in GEOM_Object thePath, in boolean theWithContact, in boolean theWithCorrection)
GEOM_Object	MakePipeShellsWithoutPath (in ListOfGO theSeqBases, in ListOfGO theLocations)
GEOM_Object	MakePipeBiNormalAlongVector (in GEOM_Object theBase, in GEOM_Object thePath, in GEOM_Object theVec)
boolean	IsDone ()
void	SetErrorCode (in string theErrorID)
string	GetErrorCode ()
long	GetStudyID ()
void	StartOperation ()
void	FinishOperation ()
void	AbortOperation ()

---

Detailed Description

GEOM_I3DPrimOperations: Interface for 3D primitives creation Box, Cylinder, Cone, Sphere, Prism (extrusion), Pipe (extrusion along contour), Revolution, Solid (from shell).

---

Member Function Documentation

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeBoxDXDYDZ	(	in double	theDX,
		in double	theDY,
		in double	theDZ
	)

Create a box with specified dimensions along the coordinate axes and with edges, parallel to the coordinate axes. Center of the box will be at point (DX/2, DY/2, DZ/2).

Parameters:

theDX	Length of Box edges, parallel to OX axis.
theDY	Length of Box edges, parallel to OY axis.
theDZ	Length of Box edges, parallel to OZ axis.

Returns:

New GEOM_Object, containing the created box.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeBoxTwoPnt	(	in GEOM_Object	thePnt1,
		in GEOM_Object	thePnt2
	)

Create a box with two specified opposite vertices, and with edges, parallel to the coordinate axes

Parameters:

thePnt1	First of two opposite vertices.
thePnt2	Second of two opposite vertices.

Returns:

New GEOM_Object, containing the created box.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeFaceHW	(	in double	theH,
		in double	theW,
		in short	theOrientation
	)

Create a face specified dimensions along OX-OY coordinate axes, with edges parallel to the coordinate axes. Center of the face will be at point (0, 0, 0).

Parameters:

theH	Height of the Face.
theW	Width of the Face.
theOrientation	Orientation belong axis OXY OYZ OZX

Returns:

New GEOM_Object, containing the created face.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeFaceObjHW	(	in GEOM_Object	theObj,
		in double	theH,
		in double	theW
	)

Create a face by normale vector or edge and two specified sizes, vertical (H) and horisontal (W).

Parameters:

theVec	defines plane.
theH	vertical size (height).
theW	horisontal size (width).

Returns:

New GEOM_Object, containing the created face.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeDiskPntVecR	(	in GEOM_Object	thePnt,
		in GEOM_Object	theVec,
		in double	theR
	)

Create a Disk (circular face) with given center, normal vector and radius.

Parameters:

thePnt	disk center.
theVec	Vector, normal to the plane of the disk.
theR	Disk radius.

Returns:

New GEOM_Object, containing the created disk.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeDiskThreePnt	(	in GEOM_Object	thePnt1,
		in GEOM_Object	thePnt2,
		in GEOM_Object	thePnt3
	)

Create a disk (circular face), passing through three given points

Parameters:

thePnt1,thePnt2,thePnt3

Points, defining the disk.

Returns:

New GEOM_Object, containing the created disk.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeDiskR	(	in double	theR,
		in short	theOrientation
	)

Create a disk specified dimensions along OX-OY coordinate axes, Center of the disk at point (0, 0, 0).

Parameters:

theR	of the Disk.
theOrientation	Orientation belong axis OXY OYZ OZX

Returns:

New GEOM_Object, containing the created disk.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeCylinderRH	(	in double	theR,
		in double	theH
	)

Create a cylinder with given radius and height at the origin of coordinate system. Axis of the cylinder will be collinear to the OZ axis of the coordinate system.

Parameters:

theR	Cylinder radius.
theH	Cylinder height.

Returns:

New GEOM_Object, containing the created cylinder.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeCylinderPntVecRH	(	in GEOM_Object	thePnt,
		in GEOM_Object	theAxis,
		in double	theR,
		in double	theH
	)

Create a cylinder with given base point, axis, radius and height.

Parameters:

thePnt	Central point of cylinder base.
theAxis	Cylinder axis.
theR	Cylinder radius.
theH	Cylinder height.

Returns:

New GEOM_Object, containing the created cylinder.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeConeR1R2H	(	in double	theR1,
		in double	theR2,
		in double	theH
	)

Create a cone with given height and radiuses at the origin of coordinate system. Axis of the cone will be collinear to the OZ axis of the coordinate system.

Parameters:

theR1	Radius of the first cone base.
theR2	Radius of the second cone base.

Note:

If both radiuses are non-zero, the cone will be truncated.

If the radiuses are equal, a cylinder will be created instead.

Parameters:

theH	Cone height.

Returns:

New GEOM_Object, containing the created cone.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeConePntVecR1R2H	(	in GEOM_Object	thePnt,
		in GEOM_Object	theAxis,
		in double	theR1,
		in double	theR2,
		in double	theH
	)

Create a cone with given base point, axis, height and radiuses.

Parameters:

thePnt	Central point of the first cone base.
theAxis	Cone axis.
theR1	Radius of the first cone base.
theR2	Radius of the second cone base.

Note:

If both radiuses are non-zero, the cone will be truncated.

If the radiuses are equal, a cylinder will be created instead.

Parameters:

theH	Cone height.

Returns:

New GEOM_Object, containing the created cone.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeTorusRR	(	in double	theRMajor,
		in double	theRMinor
	)

Create a torus with given radiuses at the origin of coordinate system.

Parameters:

theRMajor	Torus major radius.
theRMinor	Torus minor radius.

Returns:

New GEOM_Object, containing the created torus.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeTorusPntVecRR	(	in GEOM_Object	thePnt,
		in GEOM_Object	theVec,
		in double	theRMajor,
		in double	theRMinor
	)

Create a torus with given center, normal vector and radiuses.

Parameters:

thePnt	Torus central point.
theVec	Torus axis of symmetry.
theRMajor	Torus major radius.
theRMinor	Torus minor radius.

Returns:

New GEOM_Object, containing the created torus.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeSphereR

(

in double

theR

)

Create a sphere with given radius at the origin of coordinate system.

Parameters:

theR	Sphere radius.

Returns:

New GEOM_Object, containing the created sphere.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeSpherePntR	(	in GEOM_Object	thePnt,
		in double	theR
	)

Create a sphere with given center and radius.

Parameters:

thePnt	Sphere center.
theR	Sphere radius.

Returns:

New GEOM_Object, containing the created .

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePrismVecH	(	in GEOM_Object	theBase,
		in GEOM_Object	theVec,
		in double	theH
	)

Create a shape by extrusion of the base shape along the vector, i.e. all the space, transfixed by the base shape during its translation along the vector on the given distance.

Parameters:

theBase	Base shape to be extruded.
theVec	Direction of extrusion.
theH	Prism dimension along theVec.

Returns:

New GEOM_Object, containing the created prism.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePrismVecH2Ways	(	in GEOM_Object	theBase,
		in GEOM_Object	theVec,
		in double	theH
	)

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePrismVecHWithScaling	(	in GEOM_Object	theBase,
		in GEOM_Object	theVec,
		in double	theH,
		in double	theScaleFactor
	)

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePrismTwoPnt	(	in GEOM_Object	theBase,
		in GEOM_Object	thePoint1,
		in GEOM_Object	thePoint2
	)

Create a shape by extrusion of the base shape along a vector, defined by two points.

Parameters:

theBase	Base shape to be extruded.
thePoint1	First end of extrusion vector.
thePoint2	Second end of extrusion vector.

Returns:

New GEOM_Object, containing the created prism.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePrismTwoPnt2Ways	(	in GEOM_Object	theBase,
		in GEOM_Object	thePoint1,
		in GEOM_Object	thePoint2
	)

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePrismTwoPntWithScaling	(	in GEOM_Object	theBase,
		in GEOM_Object	thePoint1,
		in GEOM_Object	thePoint2,
		in double	theScaleFactor
	)

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePrismDXDYDZ	(	in GEOM_Object	theBase,
		in double	theDX,
		in double	theDY,
		in double	theDZ
	)

Create a shape by extrusion of the base shape along a vector, defined by DX DY DZ.

Parameters:

theBase	Base shape to be extruded.
DX,DY,DZ	end of extrusion vector.

Returns:

New GEOM_Object, containing the created prism.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePrismDXDYDZ2Ways	(	in GEOM_Object	theBase,
		in double	theDX,
		in double	theDY,
		in double	theDZ
	)

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePrismDXDYDZWithScaling	(	in GEOM_Object	theBase,
		in double	theDX,
		in double	theDY,
		in double	theDZ,
		in double	theScaleFactor
	)

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePipe	(	in GEOM_Object	theBase,
		in GEOM_Object	thePath
	)

Create a shape by extrusion of the base shape along the path shape. The path shape can be a wire or an edge.

Parameters:

theBase	Base shape to be extruded.
thePath	Path shape to extrude the base shape along it.

Returns:

New GEOM_Object, containing the created pipe.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeRevolutionAxisAngle	(	in GEOM_Object	theBase,
		in GEOM_Object	theAxis,
		in double	theAngle
	)

Create a shape by revolution of the base shape around the axis on the given angle, i.e. all the space, transfixed by the base shape during its rotation around the axis on the given angle.

Parameters:

theBase	Base shape to be rotated.
theAxis	Rotation axis.
theAngle	Rotation angle in radians.

Returns:

New GEOM_Object, containing the created revolution.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeRevolutionAxisAngle2Ways	(	in GEOM_Object	theBase,
		in GEOM_Object	theAxis,
		in double	theAngle
	)

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeFilling	(	in GEOM_Object	theShape,
		in long	theMinDeg,
		in long	theMaxDeg,
		in double	theTol2D,
		in double	theTol3D,
		in long	theNbIter,
		in filling_oper_method	theMethod,
		in boolean	theApprox
	)

Create a filling from the given compound of contours.

Parameters:

theMinDeg	a minimal degree of BSpline surface to create
theMaxDeg	a maximal degree of BSpline surface to create
theTol2D	a 2d tolerance to be reached
theTol3D	a 3d tolerance to be reached
theNbIter	a number of iteration of approximation algorithm
theMethod	Kind of method to perform filling operation.

Returns:

New GEOM_Object, containing the created filling surface.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakeThruSections	(	in ListOfGO	theSeqSections,
		in boolean	theModeSolid,
		in double	thePreci,
		in boolean	theRuled
	)

Create a shell or solid passing through set of sections.Sections should be wires,edges or vertices.

Parameters:

theSeqSections	- set of specified sections.
theModeSolid	- mode defining building solid or shell
thePreci	- precision 3D used for smoothing by default 1.e-6
theRuled	- mode defining type of the result surfaces (ruled or smoothed).

Returns:

New GEOM_Object, containing the created shell or solid.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePipeWithDifferentSections	(	in ListOfGO	theSeqBases,
		in ListOfGO	theLocations,
		in GEOM_Object	thePath,
		in boolean	theWithContact,
		in boolean	theWithCorrection
	)

Create a shape by extrusion of the profile shape along the path shape. The path shape can be a wire or an edge. the several profiles can be specified in the several locations of path.

Parameters:

theSeqBases	- list of Bases shape to be extruded.
theLocations	- list of locations on the path corresponding specified list of the Bases shapes. Number of locations should be equal to number of bases or list of locations can be empty.
thePath	- Path shape to extrude the base shape along it.
theWithContact	- the mode defining that the section is translated to be in contact with the spine.
-	WithCorrection - defining that the section is rotated to be orthogonal to the spine tangent in the correspondent point

Returns:

New GEOM_Object, containing the created pipe.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePipeWithShellSections	(	in ListOfGO	theSeqBases,
		in ListOfGO	theSeqSubBases,
		in ListOfGO	theLocations,
		in GEOM_Object	thePath,
		in boolean	theWithContact,
		in boolean	theWithCorrection
	)

Create a shape by extrusion of the profile shape along the path shape. The path shape can be a shell or a face. the several profiles can be specified in the several locations of path.

Parameters:

theSeqBases	- list of Bases shape to be extruded.
theSeqSubBases	- list of corresponding subshapes of section shapes.
theLocations	- list of locations on the path corresponding specified list of the Bases shapes. Number of locations should be equal to number of bases.
thePath	- Path shape to extrude the base shape along it.
theWithContact	- the mode defining that the section is translated to be in contact with the spine.
-	WithCorrection - defining that the section is rotated to be orthogonal to the spine tangent in the correspondent point

Returns:

New GEOM_Object, containing the created pipe.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePipeShellsWithoutPath	(	in ListOfGO	theSeqBases,
		in ListOfGO	theLocations
	)

Create solids between given sections

Parameters:

theSeqBases	- list of sections (shell or face).
theLocations	- list of corresponding vertexes

Returns:

New GEOM_Object, containing the created solids.

GEOM_Object GEOM.GEOM_I3DPrimOperations.MakePipeBiNormalAlongVector	(	in GEOM_Object	theBase,
		in GEOM_Object	thePath,
		in GEOM_Object	theVec
	)

Create a shape by extrusion of the base shape along the path shape with constant bi-normal direction along the given vector. The path shape can be a wire or an edge.

Parameters:

theBase	Base shape to be extruded.
thePath	Path shape to extrude the base shape along it.
theVec	Vector defines a constant binormal direction to keep the same angle beetween the Direction and the sections along the sweep surface.

Returns:

New GEOM_Object, containing the created pipe.

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