Surface¶
Transfer geological domains from 3D modelling software to Resource Estimation software.
Element¶
-
class
omf.surface.
SurfaceElement
(**kwargs)[source]¶ Contains mesh, data, textures, and options of a surface
Required Properties:
- color (
Color
): Solid color, a color, Default: random - description (
String
): Description, a unicode string - geometry (
SurfaceGeometry
,SurfaceGridGeometry
): Structure of the surface element, an instance of SurfaceGeometry or an instance of SurfaceGridGeometry - name (
String
): Title, a unicode string - subtype (
StringChoice
): Category of Surface, any of “surface”, Default: surface
Optional Properties:
- data (a list of
ProjectElementData
): Data defined on the element, a list (each item is an instance of ProjectElementData) - textures (a list of
ImageTexture
): Images mapped on the surface element, a list (each item is an instance of ImageTexture)
Other Properties:
- date_created (
GettableProperty
): Date project was created - date_modified (
GettableProperty
): Date project was modified - uid (
Uuid
): Unique identifier, a unique ID auto-generated with uuid.uuid4()
- color (
Geometry¶
Surfaces have two available geometries: SurfaceGeometry, an unstructured triangular mesh, and SurfaceGridGeometry, a gridded mesh.
SurfaceGeometry¶
-
class
omf.surface.
SurfaceGeometry
(**kwargs)[source]¶ Contains spatial information about a triangulated surface
Required Properties:
- origin (
Vector3
): Origin of the Mesh relative to origin of the Project, a 3D Vector of <type ‘float’> with shape (3), Default: [0.0, 0.0, 0.0] - triangles (
Int3Array
): Vertex indices of surface triangles, an instance of Int3Array - vertices (
Vector3Array
): Spatial coordinates of vertices relative to surface origin, an instance of Vector3Array
Other Properties:
- date_created (
GettableProperty
): Date project was created - date_modified (
GettableProperty
): Date project was modified - uid (
Uuid
): Unique identifier, a unique ID auto-generated with uuid.uuid4()
- origin (
SurfaceGridGeometry¶
-
class
omf.surface.
SurfaceGridGeometry
(**kwargs)[source]¶ Contains spatial information of a 2D grid
Required Properties:
- axis_u (
Vector3
): Vector orientation of u-direction, a 3D Vector of <type ‘float’> with shape (3), Default: X - axis_v (
Vector3
): Vector orientation of v-direction, a 3D Vector of <type ‘float’> with shape (3), Default: Y - origin (
Vector3
): Origin of the Mesh relative to origin of the Project, a 3D Vector of <type ‘float’> with shape (3), Default: [0.0, 0.0, 0.0] - tensor_u (
Array
): Grid cell widths, u-direction, a list or numpy array of <type ‘float’> with shape (*) - tensor_v (
Array
): Grid cell widths, v-direction, a list or numpy array of <type ‘float’> with shape (*)
Optional Properties:
- offset_w (
ScalarArray
): Node offset, an instance of ScalarArray
Other Properties:
- date_created (
GettableProperty
): Date project was created - date_modified (
GettableProperty
): Date project was modified - uid (
Uuid
): Unique identifier, a unique ID auto-generated with uuid.uuid4()
- axis_u (
Textures¶
Textures are ImageTexture mapped to the Surface.