Data Structures | |
class | geompy.info |
Information about closed/unclosed state of shell or wire. More... |
Functions | |
def | geompy.RaiseIfFailed |
Raise an Error, containing the Method_name, if Operation is Failed. | |
def | geompy.ParseParameters |
Return list of variables value from salome notebook. | |
def | geompy.ParseList |
Return list of variables value from salome notebook. | |
def | geompy.ParseSketcherCommand |
Return list of variables value from salome notebook. | |
def | geompy.PackData |
Helper function which can be used to pack the passed string to the byte data. | |
def | geompy.ReadTexture |
Read bitmap texture from the text file. | |
def | geompy.EnumToLong |
Returns a long value from enumeration type Can be used for CORBA enumerator types like GEOM.shape_type. | |
def | geompy.init_geom |
def | geompy.DumpPython |
Dump component to the Python script This method overrides IDL function to allow default values for the parameters. | |
def | geompy.SubShapeName |
Get name for sub-shape aSubObj of shape aMainObj. | |
def | geompy.addToStudy |
Publish in study aShape with name aName. | |
def | geompy.addToStudyInFather |
Publish in study aShape with name aName as sub-object of previously published aFather. | |
def | geompy.hideInStudy |
Unpublish object in study. | |
def | geompy.MakeCopy |
Create a copy of the given object. | |
def | geompy.addPath |
Add Path to load python scripts from. | |
def | geompy.LoadTexture |
Load marker texture from the file. | |
def | geompy.getObjectID |
Get entry of the object. | |
def | geompy.AddTexture |
Add marker texture. |
Variables | |
dictionary | geompy.ShapeType = {"AUTO":-1, "COMPOUND":0, "COMPSOLID":1, "SOLID":2, "SHELL":3, "FACE":4, "WIRE":5, "EDGE":6, "VERTEX":7, "SHAPE":8} |
Enumeration ShapeType as a dictionary. | |
geompy.kind = GEOM.GEOM_IKindOfShape | |
Kinds of shape in terms of GEOM.GEOM_IKindOfShape.shape_kind enumeration and a list of parameters, describing the shape. |
def geompy.RaiseIfFailed | ( | Method_name, | |
Operation | |||
) |
Raise an Error, containing the Method_name, if Operation is Failed.
def geompy.ParseParameters | ( | parameters | ) |
Return list of variables value from salome notebook.
def geompy.ParseList | ( | list | ) |
Return list of variables value from salome notebook.
def geompy.ParseSketcherCommand | ( | command | ) |
Return list of variables value from salome notebook.
def geompy.PackData | ( | data | ) |
Helper function which can be used to pack the passed string to the byte data.
Only '1' an '0' symbols are valid for the string. The missing bits are replaced by zeroes. If the string contains invalid symbol (neither '1' nor '0'), the function raises an exception. For example,
data | unpacked data - a string containing '1' and '0' symbols |
def geompy.ReadTexture | ( | fname | ) |
Read bitmap texture from the text file.
In that file, any non-zero symbol represents '1' opaque pixel of the bitmap. A zero symbol ('0') represents transparent pixel of the texture bitmap. The function returns width and height of the pixmap in pixels and byte stream representing texture bitmap itself.
This function can be used to read the texture to the byte stream in order to pass it to the AddTexture() function of geompy class. For example,
fname | texture file name |
References geompy.PackData().
def geompy.EnumToLong | ( | theItem | ) |
Returns a long value from enumeration type Can be used for CORBA enumerator types like GEOM.shape_type.
theItem | enumeration type |
def geompy.init_geom | ( | self, | |
theStudy | |||
) |
def geompy.DumpPython | ( | self, | |
theStudy, | |||
theIsPublished = True , |
|||
theIsMultiFile = True |
|||
) |
Dump component to the Python script This method overrides IDL function to allow default values for the parameters.
def geompy.SubShapeName | ( | self, | |
aSubObj, | |||
aMainObj | |||
) |
def geompy.addToStudy | ( | self, | |
aShape, | |||
aName, | |||
doRestoreSubShapes = False , |
|||
theArgs = [] , |
|||
theFindMethod = GEOM.FSM_GetInPlace , |
|||
theInheritFirstArg = False |
|||
) |
Publish in study aShape with name aName.
aShape | the shape to be published |
aName | the name for the shape |
doRestoreSubShapes | if True, finds and publishes also sub-shapes of aShape, corresponding to its arguments and published sub-shapes of arguments |
theArgs,theFindMethod,theInheritFirstArg | see RestoreSubShapes() for these arguments description |
def geompy.addToStudyInFather | ( | self, | |
aFather, | |||
aShape, | |||
aName | |||
) |
Publish in study aShape with name aName as sub-object of previously published aFather.
aFather | previously published object |
aShape | the shape to be published as sub-object of aFather |
aName | the name for the shape |
def geompy.hideInStudy | ( | self, | |
obj | |||
) |
Unpublish object in study.
obj | the object to be unpublished |
References geompy.RestoreSubShapes().
def geompy.MakeCopy | ( | self, | |
theOriginal | |||
) |
Create a copy of the given object.
theOriginal | geometry object for copy |
References geompy.RaiseIfFailed().
def geompy.addPath | ( | self, | |
Path | |||
) |
Add Path to load python scripts from.
Path | a path to load python scripts from |
def geompy.LoadTexture | ( | self, | |
Path | |||
) |
Load marker texture from the file.
Path | a path to the texture file |
References geompy.RaiseIfFailed().
def geompy.getObjectID | ( | self, | |
obj | |||
) |
Get entry of the object.
obj | geometry object |
def geompy.AddTexture | ( | self, | |
Width, | |||
Height, | |||
Texture, | |||
RowData = False |
|||
) |
Add marker texture.
Width and Height parameters specify width and height of the texture in pixels. If RowData is True
, Texture parameter should represent texture data packed into the byte array. If RowData is False
(default), Texture parameter should be unpacked string, in which '1' symbols represent opaque pixels and '0' represent transparent pixels of the texture bitmap.
Width | texture width in pixels |
Height | texture height in pixels |
Texture | texture data |
RowData | if True , Texture data are packed in the byte stream |
References geompy.AddTexture(), geompy.init_geom(), geompy.PackData(), and geompy.RaiseIfFailed().
dictionary geompy.ShapeType = {"AUTO":-1, "COMPOUND":0, "COMPSOLID":1, "SOLID":2, "SHELL":3, "FACE":4, "WIRE":5, "EDGE":6, "VERTEX":7, "SHAPE":8} |
Enumeration ShapeType as a dictionary.
Topological types of shapes (like Open Cascade types). See GEOM::shape_type for details.
geompy.kind = GEOM.GEOM_IKindOfShape |
Kinds of shape in terms of GEOM.GEOM_IKindOfShape.shape_kind enumeration and a list of parameters, describing the shape.
List of parameters, describing the shape: