Version: 9.16.0
Home
Loading...
Searching...
No Matches

Functions

 MakeBox (self, x1, y1, z1, x2, y2, z2, theName=None)
 Create a box by coordinates of two opposite vertices.
 
 MakeBoxDXDYDZ (self, theDX, theDY, theDZ, theName=None)
 Create a box with specified dimensions along the coordinate axes and with edges, parallel to the coordinate axes.
 
 MakeBoxTwoPnt (self, thePnt1, thePnt2, theName=None)
 Create a box with two specified opposite vertices, and with edges, parallel to the coordinate axes.
 
 MakeFaceHW (self, theH, theW, theOrientation, theName=None)
 Create a face with specified dimensions with edges parallel to coordinate axes.
 
 MakeFaceObjHW (self, theObj, theH, theW, theName=None)
 Create a face from another plane and two sizes, vertical size and horisontal size.
 
 MakeDiskPntVecR (self, thePnt, theVec, theR, theName=None)
 Create a disk with given center, normal vector and radius.
 
 MakeDiskThreePnt (self, thePnt1, thePnt2, thePnt3, theName=None)
 Create a disk, passing through three given points.
 
 MakeDiskR (self, theR, theOrientation, theName=None)
 Create a disk with specified dimensions along OX-OY coordinate axes.
 
 MakeCylinder (self, thePnt, theAxis, theR, theH, theName=None)
 Create a cylinder with given base point, axis, radius and height.
 
 MakeCylinderA (self, thePnt, theAxis, theR, theH, theA, theName=None)
 Create a portion of cylinder with given base point, axis, radius, height and angle.
 
 MakeCylinderRH (self, theR, theH, theName=None)
 Create a cylinder with given radius and height at the origin of coordinate system.
 
 MakeCylinderRHA (self, theR, theH, theA, theName=None)
 Create a portion of cylinder with given radius, height and angle at the origin of coordinate system.
 
 MakeSpherePntR (self, thePnt, theR, theName=None)
 Create a sphere with given center and radius.
 
 MakeSphere (self, x, y, z, theR, theName=None)
 Create a sphere with given center and radius.
 
 MakeSphereR (self, theR, theName=None)
 Create a sphere with given radius at the origin of coordinate system.
 
 MakeCone (self, thePnt, theAxis, theR1, theR2, theH, theName=None)
 Create a cone with given base point, axis, height and radiuses.
 
 MakeConeR1R2H (self, theR1, theR2, theH, theName=None)
 Create a cone with given height and radiuses at the origin of coordinate system.
 
 MakeTorus (self, thePnt, theVec, theRMajor, theRMinor, theName=None)
 Create a torus with given center, normal vector and radiuses.
 
 MakeTorusRR (self, theRMajor, theRMinor, theName=None)
 Create a torus with given radiuses at the origin of coordinate system.
 

Detailed Description

Function Documentation

◆ MakeBox()

MakeBox (   self,
  x1,
  y1,
  z1,
  x2,
  y2,
  z2,
  theName = None 
)

Create a box by coordinates of two opposite vertices.

Parameters
x1,y1,z1double values, defining first point it.
x2,y2,z2double values, defining first point it.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created box.

Example

References GEOM_I3DPrimOperations.MakeBoxTwoPnt(), geomBuilder.MakeBoxTwoPnt(), and geomBuilder.MakeVertex().

◆ MakeBoxDXDYDZ()

MakeBoxDXDYDZ (   self,
  theDX,
  theDY,
  theDZ,
  theName = None 
)

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
theDXLength of Box edges, parallel to OX axis.
theDYLength of Box edges, parallel to OY axis.
theDZLength of Box edges, parallel to OZ axis.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created box.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeBoxDXDYDZ(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeBoxTwoPnt()

MakeBoxTwoPnt (   self,
  thePnt1,
  thePnt2,
  theName = None 
)

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

Parameters
thePnt1First of two opposite vertices.
thePnt2Second of two opposite vertices.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created box.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeBoxTwoPnt(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeFaceHW()

MakeFaceHW (   self,
  theH,
  theW,
  theOrientation,
  theName = None 
)

Create a face with specified dimensions with edges parallel to coordinate axes.

Parameters
theHheight of Face.
theWwidth of Face.
theOrientationface orientation: 1-OXY, 2-OYZ, 3-OZX
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created face.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeFaceHW(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeFaceObjHW()

MakeFaceObjHW (   self,
  theObj,
  theH,
  theW,
  theName = None 
)

Create a face from another plane and two sizes, vertical size and horisontal size.

Parameters
theObjNormale vector to the creating face or the face object.
theHHeight (vertical size).
theWWidth (horisontal size).
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created face.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeFaceObjHW(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeDiskPntVecR()

MakeDiskPntVecR (   self,
  thePnt,
  theVec,
  theR,
  theName = None 
)

Create a disk with given center, normal vector and radius.

Parameters
thePntDisk center.
theVecVector, normal to the plane of the disk.
theRDisk radius.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created disk.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeDiskPntVecR(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeDiskThreePnt()

MakeDiskThreePnt (   self,
  thePnt1,
  thePnt2,
  thePnt3,
  theName = None 
)

Create a disk, passing through three given points.

Parameters
thePnt1,thePnt2,thePnt3Points, defining the disk.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created disk.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeDiskThreePnt(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeDiskR()

MakeDiskR (   self,
  theR,
  theOrientation,
  theName = None 
)

Create a disk with specified dimensions along OX-OY coordinate axes.

Parameters
theRRadius of Face.
theOrientationset the orientation belong axis OXY or OYZ or OZX
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created disk.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeDiskR(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeCylinder()

MakeCylinder (   self,
  thePnt,
  theAxis,
  theR,
  theH,
  theName = None 
)

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

Parameters
thePntCentral point of cylinder base.
theAxisCylinder axis.
theRCylinder radius.
theHCylinder height.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created cylinder.

Example

References geomBuilder._autoPublish(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeCylinderA()

MakeCylinderA (   self,
  thePnt,
  theAxis,
  theR,
  theH,
  theA,
  theName = None 
)

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

Parameters
thePntCentral point of cylinder base.
theAxisCylinder axis.
theRCylinder radius.
theHCylinder height.
theACylinder angle in radians.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created cylinder.

Example

References geomBuilder._autoPublish(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeCylinderRH()

MakeCylinderRH (   self,
  theR,
  theH,
  theName = None 
)

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
theRCylinder radius.
theHCylinder height.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created cylinder.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeCylinderRH(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeCylinderRHA()

MakeCylinderRHA (   self,
  theR,
  theH,
  theA,
  theName = None 
)

Create a portion of cylinder with given radius, height and angle at the origin of coordinate system.

Axis of the cylinder will be collinear to the OZ axis of the coordinate system.

Parameters
theRCylinder radius.
theHCylinder height.
theACylinder angle in radians.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created cylinder.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeCylinderRHA(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeSpherePntR()

MakeSpherePntR (   self,
  thePnt,
  theR,
  theName = None 
)

Create a sphere with given center and radius.

Parameters
thePntSphere center.
theRSphere radius.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created sphere.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeSpherePntR(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeSphere()

MakeSphere (   self,
  x,
  y,
  z,
  theR,
  theName = None 
)

Create a sphere with given center and radius.

Parameters
x,y,zCoordinates of sphere center.
theRSphere radius.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created sphere.

Example

References GEOM_I3DPrimOperations.MakeSpherePntR(), geomBuilder.MakeSpherePntR(), and geomBuilder.MakeVertex().

◆ MakeSphereR()

MakeSphereR (   self,
  theR,
  theName = None 
)

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

Parameters
theRSphere radius.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created sphere.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeSphereR(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeCone()

MakeCone (   self,
  thePnt,
  theAxis,
  theR1,
  theR2,
  theH,
  theName = None 
)

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

Parameters
thePntCentral point of the first cone base.
theAxisCone axis.
theR1Radius of the first cone base.
theR2Radius 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
theHCone height.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created cone.

Example

References geomBuilder._autoPublish(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeConeR1R2H()

MakeConeR1R2H (   self,
  theR1,
  theR2,
  theH,
  theName = None 
)

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
theR1Radius of the first cone base.
theR2Radius 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
theHCone height.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created cone.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeConeR1R2H(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeTorus()

MakeTorus (   self,
  thePnt,
  theVec,
  theRMajor,
  theRMinor,
  theName = None 
)

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

Parameters
thePntTorus central point.
theVecTorus axis of symmetry.
theRMajorTorus major radius.
theRMinorTorus minor radius.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created torus.

Example

References geomBuilder._autoPublish(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().

◆ MakeTorusRR()

MakeTorusRR (   self,
  theRMajor,
  theRMinor,
  theName = None 
)

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

Parameters
theRMajorTorus major radius.
theRMinorTorus minor radius.
theNameObject name; when specified, this parameter is used for result publication in the study. Otherwise, if automatic publication is switched on, default value is used for result name.
Returns
New GEOM.GEOM_Object, containing the created torus.

Example

References geomBuilder._autoPublish(), geomBuilder.MakeTorusRR(), geomBuilder.ParseParameters(), geomBuilder.PrimOp, and geomBuilder.RaiseIfFailed().