Version: 9.15.0
Home

Data Structures

class  geomField
 Field on Geometry. More...
 

Functions

def CreateField (self, shape, name, type, dimension, componentNames)
 Creates a field. More...
 
def RemoveField (self, field)
 Removes a field from the GEOM component. More...
 
def CountFields (self, shape)
 Returns number of fields on a shape. More...
 
def GetFields (self, shape)
 Returns all fields on a shape. More...
 
def GetField (self, shape, name)
 Returns a field on a shape by its name. More...
 

Detailed Description

Function Documentation

◆ CreateField()

def CreateField (   self,
  shape,
  name,
  type,
  dimension,
  componentNames 
)

Creates a field.

Parameters
shapethe shape the field lies on
namethe field name
typetype of field data: 0 - bool, 1 - int, 2 - double, 3 - string
dimensiondimension of the shape the field lies on 0 - VERTEX, 1 - EDGE, 2 - FACE, 3 - SOLID, -1 - whole shape
componentNamesnames of components
Returns
a created field

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

◆ RemoveField()

def RemoveField (   self,
  field 
)

Removes a field from the GEOM component.

Parameters
fieldthe field to remove

◆ CountFields()

def CountFields (   self,
  shape 
)

Returns number of fields on a shape.

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

◆ GetFields()

def GetFields (   self,
  shape 
)

Returns all fields on a shape.

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

◆ GetField()

def GetField (   self,
  shape,
  name 
)

Returns a field on a shape by its name.

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