SALOME documentation central

Auxiliary data structures and methods

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.init_geom
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.MakeCopy
 Create a copy of the given objectExample.
def geompy.addPath
 Add Path to load python scripts from.
def geompy.LoadTexture
 Load marker texture from the file.
def geompy.AddTexture
 Add marker texture.

Variables

dictionary geompy.ShapeType = {"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 enumeration.

Function Documentation

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,

 val = PackData("10001110") # val = 0xAE
 val = PackData("1")        # val = 0x80
Parameters:
data unpacked data - a string containing '1' and '0' symbols
Returns:
data packed to the byte stream
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,

 import geompy
 geompy.init_geom(salome.myStudy)
 texture = geompy.readtexture('mytexture.dat')
 texture = geompy.AddTexture(*texture)
 obj.SetMarkerTexture(texture)
Parameters:
fname texture file name
Returns:
sequence of tree values: texture's width, height in pixels and its byte stream
def geompy.init_geom (   self,
  theStudy 
)
def geompy.SubShapeName (   self,
  aSubObj,
  aMainObj 
)

Get name for sub-shape aSubObj of shape aMainObj.

Example

def geompy.addToStudy (   self,
  aShape,
  aName,
  doRestoreSubShapes = False,
  theArgs = [],
  theFindMethod = GEOM.FSM_GetInPlace,
  theInheritFirstArg = False 
)

Publish in study aShape with name aName.

Parameters:
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 geompy.RestoreSubShapes for these arguments description
Returns:
study entry of the published shape in form of string

Example

def geompy.addToStudyInFather (   self,
  aFather,
  aShape,
  aName 
)

Publish in study aShape with name aName as sub-object of previously published aFather.

Example

def geompy.MakeCopy (   self,
  theOriginal 
)

Create a copy of the given objectExample.

def geompy.addPath (   self,
  Path 
)

Add Path to load python scripts from.

def geompy.LoadTexture (   self,
  Path 
)

Load marker texture from the file.

Parameters:
Path a path to the texture file
Returns:
unique texture identifier
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.

Parameters:
Width texture width in pixels
Height texture height in pixels
Texture texture data
RowData if True, Texture data are packed in the byte stream

Variable Documentation

dictionary geompy.ShapeType = {"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 enumeration.

 All Data Structures Namespaces Files Functions Variables

Copyright © 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS