GSTPy.IParsingActions — GSTPy documentation

# GSTPy.IParsingActions

class `GSTPy.``IParsingActions`

  Allows to retrieve a geometry in a custom format.

  See also

  - `NetworkInterface.get_feature_custom_format()`

  - IParsingActions example

  `add_point`((IParsingActions)self, (RawPoint3)point) → None :

    Adds a new point to the geometry.

    Parameters

      point (RawPoint3) – The new point.

  `add_property_value`((IParsingActions)self, (str)value) → None :

    Adds a property value.

    Parameters

      value (str) – The property value.

  `add_tetrahedron`((IParsingActions)self, (IdxTetrahedron)tetrahedron) → None :

    Adds a new tetrahedron to the geometry.

    Parameters

      tetrahedron (IdxTetrahedron) – The new tetrahedron.

  `add_triangle`((IParsingActions)self, (IdxTriangle)triangle) → None :

    Adds a new triangle to the geometry.

    Parameters

      triangle (IdxTriangle) – The new triangle.

  `create_cell_property`((IParsingActions)self, (str)name, (PropertyTypes)type) → None :

    Creates a simplex property on the cell level.

    Depending on the type of feature this is either on a line segment, triangle or tetrahedron.

    Parameters

      - name (str) – The name of the simplex property.

      - type (PropertyTypes) – The type of the property.

  `create_grid3`((IParsingActions)self, (GridDescription)grid_description) → None :

    Starts creation a geometry of type Grid3

    The Properties are created with `create_vertex_property()`. Then `add_property_value()` is then called for each property and Grid-cell of the geometry.` :param grid_description: This describes the :type grid_description: GridDescription :param grids position: :param orientation and cell-size.:

  `create_multiline3`((IParsingActions)self) → None :

    Starts creation a geometry of type Multiline3.

    `add_point()` will be called, once for each point of a linestring. `new_simplex()` indicates that the current linestring is complete and a new linestring will be next. To finish `geometry_parsing_finished()` will be called once.

    If there are any properties, they will now be created with `create_vertex_property()`. Then `add_property_value()` will be called, once for each point of the geometry. To finish `property_parsing_finished()` will be called once.

  `create_multipoint3`((IParsingActions)self) → None :

    Starts creation a geometry of type Multipoint3.

    `add_point()` will be called, once for each point of the geometry. To finish `geometry_parsing_finished()` will be called once.

    If there are any properties, they will now be created with `create_vertex_property()`. Then `add_property_value()` will be called, once for each point of the geometry. To finish `property_parsing_finished()` will be called once.

  `create_tetrahedon_net3`((IParsingActions)self) → None :

    Starts creation a geometry of type Multipolygon3

    `add_point()` will be called, once for each point of the geometry. After that `add_tetrahedron()` will be called, once for each tetrahedron of the geometry. To finish `geometry_parsing_finished()` will be called once.

    If there are any properties, they will now be created with `create_vertex_property()`. Then `add_property_value()` will be called, once for each point of the geometry. To finish `property_parsing_finished()` will be called once.

  `create_triangle_net3`((IParsingActions)self) → None :

    Starts creation a geometry of type Tin3.

    `add_point()` will be called, once for each point of the geometry. After that `add_triangle()` will be called, once for each triangle of the geometry. To finish `geometry_parsing_finished()` will be called once.

    If there are any properties, they will now be created with `create_vertex_property()`. Then `add_property_value()` will be called, once for each point of the geometry. To finish `property_parsing_finished()` will be called once.

  `create_vertex_property`((IParsingActions)self, (str)name, (PropertyTypes)type) → None :

    Creates a simplex property on the vertex level.

    Parameters

      - name (str) – The name of the simplex property.

      - type (PropertyTypes) – The type of the property.

  `geometry_parsing_finished`((IParsingActions)self) → None :

    Called after all geometry data was added.

  `new_simplex`((IParsingActions)self) → None :

    Indicates that the current linestring is finished.

    The next point from `add_point()` belongs to a new linestring.

  `property_parsing_finished`((IParsingActions)self) → None :

    Called after all property data was added.

  `set_color`((IParsingActions)self, (Color)color) → None :

    Sets the color of this feature.

    Parameters

      color (Color) – The color of this feature.

  `set_custom_property`((IParsingActions)self, (str)name, (str)value) → None :

    Sets an object property of this feature.

    Parameters

      - name (str) – The name of the property.

      - value (str) – The value of the property.

  `set_name`((IParsingActions)self, (str)name) → None :

    Sets the name of this feature.

    Parameters

      name (str) – The name of this feature.

  `set_transparency`((IParsingActions)self, (float)transparency) → None :

    Sets the transparency of this feature.

    Parameters

      transparency (float) – The transparency of this feature (range: 0. .. 1.).