Data Structures | |
| class | info |
| Information about closed/unclosed state of shell or wire. More... | |
Functions | |
| RaiseIfFailed (Method_name, Operation) | |
| Raise an Error, containing the Method_name, if Operation is Failed. | |
| ParseParameters (*parameters) | |
| Return list of variables value from salome notebook. | |
| ParseList (list) | |
| Return list of variables value from salome notebook. | |
| ParseSketcherCommand (command) | |
| Return list of variables value from salome notebook. | |
| PackData (data) | |
| Helper function which can be used to pack the passed string to the byte data. | |
| ReadTexture (fname) | |
| Read bitmap texture from the text file. | |
| EnumToLong (theItem) | |
| Returns a long value from enumeration type Can be used for CORBA enumerator types like GEOM.shape_type. | |
| init_geom (self) | |
| GetPluginOperations (self, libraryName) | |
| DumpPython (self, theIsPublished=True, theIsMultiFile=True) | |
| Dump component to the Python script This method overrides IDL function to allow default values for the parameters. | |
| SubShapeName (self, aSubObj, aMainObj) | |
| Get name for sub-shape aSubObj of shape aMainObj. | |
| hideInStudy (self, obj) | |
| Unpublish object in study. | |
| MakeCopy (self, theOriginal, theName=None) | |
| Create a copy of the given object. | |
| addPath (self, Path) | |
| Add Path to load python scripts from. | |
| LoadTexture (self, Path) | |
| Load marker texture from the file. | |
| getObjectID (self, obj) | |
| Get internal name of the object based on its study entry. | |
| AddTexture (self, Width, Height, Texture, RowData=False) | |
| Add marker texture. | |
| TransferData (self, theObjectFrom, theObjectTo, theFindMethod=GEOM.FSM_GetInPlace) | |
| Transfer not topological data from one GEOM object to another. | |
Variables | |
| dict | ShapeType = {"AUTO":-1, "COMPOUND":0, "COMPSOLID":1, "SOLID":2, "SHELL":3, "FACE":4, "WIRE":5, "EDGE":6, "VERTEX":7, "SHAPE":8, "FLAT":9} |
| Enumeration ShapeType as a dictionary. | |
| kind = GEOM.GEOM_IKindOfShape | |
| Kinds of shape in terms of GEOM.GEOM_IKindOfShape.shape_kind enumeration and a list of parameters, describing the shape. | |
| RaiseIfFailed | ( | Method_name, | |
| Operation | |||
| ) |
Raise an Error, containing the Method_name, if Operation is Failed.
| ParseParameters | ( | * | parameters | ) |
Return list of variables value from salome notebook.
References geomBuilder.ParseParameters().
| ParseList | ( | list | ) |
Return list of variables value from salome notebook.
| ParseSketcherCommand | ( | command | ) |
Return list of variables value from salome notebook.
| 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 |
| 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 geomBuilder class. For example,
| fname | texture file name |
References geomBuilder.PackData().
| EnumToLong | ( | theItem | ) |
Returns a long value from enumeration type Can be used for CORBA enumerator types like GEOM.shape_type.
| theItem | enumeration type |
| init_geom | ( | self | ) |
| GetPluginOperations | ( | self, | |
| libraryName | |||
| ) |
| DumpPython | ( | self, | |
theIsPublished = True, |
|||
theIsMultiFile = True |
|||
| ) |
Dump component to the Python script This method overrides IDL function to allow default values for the parameters.
| SubShapeName | ( | self, | |
| aSubObj, | |||
| aMainObj | |||
| ) |
| hideInStudy | ( | self, | |
| obj | |||
| ) |
Unpublish object in study.
| obj | the object to be unpublished |
References geomBuilder.myBuilder, and geomBuilder.myStudy.
| MakeCopy | ( | self, | |
| theOriginal, | |||
theName = None |
|||
| ) |
Create a copy of the given object.
| theOriginal | geometry object for copy |
| theName | Object 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. |
References geomBuilder._autoPublish(), geomBuilder.InsertOp, geomBuilder.MakeCopy(), and geomBuilder.RaiseIfFailed().
| addPath | ( | self, | |
| Path | |||
| ) |
Add Path to load python scripts from.
| Path | a path to load python scripts from |
| LoadTexture | ( | self, | |
| Path | |||
| ) |
Load marker texture from the file.
| Path | a path to the texture file |
References geomBuilder.InsertOp, geomBuilder.LoadTexture(), and geomBuilder.RaiseIfFailed().
| getObjectID | ( | self, | |
| obj | |||
| ) |
Get internal name of the object based on its study entry.
| obj | geometry object |
| 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 geomBuilder.AddTexture(), geomBuilder.InsertOp, geomBuilder.PackData(), and geomBuilder.RaiseIfFailed().
| TransferData | ( | self, | |
| theObjectFrom, | |||
| theObjectTo, | |||
theFindMethod = GEOM.FSM_GetInPlace |
|||
| ) |
Transfer not topological data from one GEOM object to another.
| theObjectFrom | the source object of non-topological data |
| theObjectTo | the destination object of non-topological data |
| theFindMethod | method to search sub-shapes of theObjectFrom in shape theObjectTo. Possible values are: GEOM.FSM_GetInPlace, GEOM.FSM_GetInPlaceByHistory and GEOM.FSM_GetInPlace_Old. Other values of GEOM.find_shape_method are not supported. |
References geomBuilder.InsertOp, geomBuilder.RaiseIfFailed(), and geomBuilder.TransferData().
|
static |
Enumeration ShapeType as a dictionary.
Topological types of shapes (like Open Cascade types). See GEOM::shape_type for details.
|
static |
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: