Version: 9.16.0
Home
Loading...
Searching...
No Matches

Data Structures

class  geomField
 Field on Geometry. More...
 

Functions

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

Detailed Description

Function Documentation

◆ CreateField()

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.CreateField(), geomBuilder.FieldOp, and geomBuilder.RaiseIfFailed().

◆ RemoveField()

RemoveField (   self,
  field 
)

Removes a field from the GEOM component.

Parameters
fieldthe field to remove

◆ CountFields()

CountFields (   self,
  shape 
)

Returns number of fields on a shape.

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

◆ GetFields()

GetFields (   self,
  shape 
)

Returns all fields on a shape.

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

◆ GetField()

GetField (   self,
  shape,
  name 
)

Returns a field on a shape by its name.

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