Auxiliary data structures and methods

Data Structures
class	info
	Information about closed/unclosed state of shell or wire. More...

Functions
def	RaiseIfFailed
	Raise an Error, containing the Method_name, if Operation is Failed. More...
def	ParseParameters
	Return list of variables value from salome notebook. More...
def	ParseList
	Return list of variables value from salome notebook. More...
def	ParseSketcherCommand
	Return list of variables value from salome notebook. More...
def	PackData
	Helper function which can be used to pack the passed string to the byte data. More...
def	ReadTexture
	Read bitmap texture from the text file. More...
def	EnumToLong
	Returns a long value from enumeration type Can be used for CORBA enumerator types like GEOM.shape_type. More...
def	init_geom
def	GetPluginOperations
def	DumpPython
	Dump component to the Python script This method overrides IDL function to allow default values for the parameters. More...
def	SubShapeName
	Get name for sub-shape aSubObj of shape aMainObj. More...
def	hideInStudy
	Unpublish object in study. More...
def	MakeCopy
	Create a copy of the given object. More...
def	addPath
	Add Path to load python scripts from. More...
def	LoadTexture
	Load marker texture from the file. More...
def	getObjectID
	Get internal name of the object based on its study entry. More...
def	AddTexture
	Add marker texture. More...
def	TransferData
	Transfer not topological data from one GEOM object to another. More...

Variables
dictionary	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. More...
	kind = GEOM.GEOM_IKindOfShape
	Kinds of shape in terms of GEOM.GEOM_IKindOfShape.shape_kind enumeration and a list of parameters, describing the shape. More...

Detailed Description

Function Documentation

def geomBuilder.RaiseIfFailed	(		Method_name,
			Operation
	)

Raise an Error, containing the Method_name, if Operation is Failed.

def geomBuilder.ParseParameters

(

parameters

)

Return list of variables value from salome notebook.

def geomBuilder.ParseList

(

list

)

Return list of variables value from salome notebook.

def geomBuilder.ParseSketcherCommand

(

command

)

Return list of variables value from salome notebook.

def geomBuilder.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 geomBuilder.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,

from salome.geom import geomBuilder
geompy = geomBuilder.New(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

References geomBuilder.PackData().

def geomBuilder.EnumToLong

(

theItem

)

Returns a long value from enumeration type Can be used for CORBA enumerator types like GEOM.shape_type.

Parameters

theItem

enumeration type

def init_geom	(		self,
			theStudy
	)

def GetPluginOperations	(		self,
			studyID,
			libraryName
	)

def 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.

References geomBuilder.ManageTransactions().

def SubShapeName	(		self,
			aSubObj,
			aMainObj
	)

Get name for sub-shape aSubObj of shape aMainObj.

Example

References geomBuilder.addToStudy().

def hideInStudy	(		self,
			obj
	)

Unpublish object in study.

Parameters

obj	the object to be unpublished

References geomBuilder.RestoreSubShapes().

def MakeCopy	(		self,
			theOriginal,
			theName = None
	)

Create a copy of the given object.

Parameters

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.

Returns

New GEOM_Object, containing the copied shape.

Example

References geomBuilder._autoPublish(), geomBuilder.InsertOp, and geomBuilder.RaiseIfFailed().

def addPath	(		self,
			Path
	)

Add Path to load python scripts from.

Parameters

Path	a path to load python scripts from

References geomBuilder.ManageTransactions().

def LoadTexture	(		self,
			Path
	)

Load marker texture from the file.

Parameters

Path	a path to the texture file

Returns

unique texture identifier

References geomBuilder.InsertOp, and geomBuilder.RaiseIfFailed().

def getObjectID	(		self,
			obj
	)

Get internal name of the object based on its study entry.

Note

This method does not provide an unique identifier of the geometry object.

This is internal function of GEOM component, though it can be used outside it for appropriate reason (e.g. for identification of geometry object).

Parameters

obj	geometry object

Returns

unique object identifier

References geomBuilder.ManageTransactions().

def 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

Returns

unique texture identifier

References geomBuilder.InsertOp, geomBuilder.ManageTransactions(), geomBuilder.PackData(), geomBuilder.RaiseIfFailed(), and geomBuilder.TransferData().

def TransferData	(		self,
			theObjectFrom,
			theObjectTo,
			theFindMethod = GEOM.FSM_GetInPlace
	)

Transfer not topological data from one GEOM object to another.

Parameters

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.

Returns

True in case of success; False otherwise.

Example

References geomBuilder.InsertOp, and geomBuilder.RaiseIfFailed().

Variable Documentation

dictionary ShapeType = {"AUTO":-1, "COMPOUND":0, "COMPSOLID":1, "SOLID":2, "SHELL":3, "FACE":4, "WIRE":5, "EDGE":6, "VERTEX":7, "SHAPE":8, "FLAT":9}

static

Enumeration ShapeType as a dictionary.

Topological types of shapes (like Open Cascade types). See GEOM::shape_type for details.

kind = GEOM.GEOM_IKindOfShape

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:

• COMPOUND: [nb_solids nb_faces nb_edges nb_vertices]
• COMPSOLID: [nb_solids nb_faces nb_edges nb_vertices]

• SHELL: [info.CLOSED / info.UNCLOSED nb_faces nb_edges nb_vertices]

• WIRE: [info.CLOSED / info.UNCLOSED nb_edges nb_vertices]

• SPHERE: [xc yc zc R]
• CYLINDER: [xb yb zb dx dy dz R H]
• BOX: [xc yc zc ax ay az]
• ROTATED_BOX: [xc yc zc zx zy zz xx xy xz ax ay az]
• TORUS: [xc yc zc dx dy dz R_1 R_2]
• CONE: [xb yb zb dx dy dz R_1 R_2 H]
• POLYHEDRON: [nb_faces nb_edges nb_vertices]
• SOLID: [nb_faces nb_edges nb_vertices]

• SPHERE2D: [xc yc zc R]
• CYLINDER2D: [xb yb zb dx dy dz R H]
• TORUS2D: [xc yc zc dx dy dz R_1 R_2]
• CONE2D: [xc yc zc dx dy dz R_1 R_2 H]
• DISK_CIRCLE: [xc yc zc dx dy dz R]
• DISK_ELLIPSE: [xc yc zc dx dy dz R_1 R_2]
• POLYGON: [xo yo zo dx dy dz nb_edges nb_vertices]
• PLANE: [xo yo zo dx dy dz]
• PLANAR: [xo yo zo dx dy dz nb_edges nb_vertices]
• FACE: [nb_edges nb_vertices]

• CIRCLE: [xc yc zc dx dy dz R]
• ARC_CIRCLE: [xc yc zc dx dy dz R x1 y1 z1 x2 y2 z2]
• ELLIPSE: [xc yc zc dx dy dz R_1 R_2]
• ARC_ELLIPSE: [xc yc zc dx dy dz R_1 R_2 x1 y1 z1 x2 y2 z2]
• LINE: [xo yo zo dx dy dz]
• SEGMENT: [x1 y1 z1 x2 y2 z2]
• EDGE: [nb_vertices]

• VERTEX: [x y z]

• LCS: [x y z xx xy xz yx yy yz zx zy zz]