znvis.mesh package

Submodules

znvis.mesh.custom module

ZnVis: A Zincwarecode package.

License

This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html SPDX-License-Identifier: EPL-2.0 Copyright Contributors to the Zincwarecode Project.

Contact Information

email: zincwarecode@gmail.com github: https://github.com/zincware web: https://zincwarecode.com/

Citation

If you use this module please cite us with:

Summary

Create a custom mesh

class znvis.mesh.custom.CustomMesh(material: znvis.material.material.Material = Material(colour=array([0.23137255, 0.20784314, 0.38039216]), alpha=1.0, roughness=0.5, metallic=0.0, reflectance=0.4, anisotropy=0.4), file: Optional[str] = None)

Bases: znvis.mesh.mesh.Mesh

A class to produce cylinder meshes.

Attributes

filestr

Path to mesh file.

create_mesh(starting_position: numpy.ndarray, starting_orientation: Optional[numpy.ndarray] = None) → open3d.cpu.pybind.geometry.TriangleMesh

Create a mesh object defined by the dataclass.

Parameters

starting_positionnp.ndarray shape=(3,)

Starting position of the mesh.

starting_orientationnp.ndarray shape=(3,) (default = None)

Starting orientation of the mesh.

Returns

mesho3d.geometry.TriangleMesh

file: str = None

znvis.mesh.cylinder module

ZnVis: A Zincwarecode package.

License

This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html SPDX-License-Identifier: EPL-2.0 Copyright Contributors to the Zincwarecode Project.

Contact Information

email: zincwarecode@gmail.com github: https://github.com/zincware web: https://zincwarecode.com/

Citation

If you use this module please cite us with:

Summary

Create a cylinder mesh

class znvis.mesh.cylinder.Cylinder(material: znvis.material.material.Material = Material(colour=array([0.23137255, 0.20784314, 0.38039216]), alpha=1.0, roughness=0.5, metallic=0.0, reflectance=0.4, anisotropy=0.4), radius: float = 1.0, height: float = 3.0, split: int = 1, resolution: int = 10)

Bases: znvis.mesh.mesh.Mesh

A class to produce cylinder meshes.

Attributes

radiusfloat

Radius of the sphere.

heightfloat

Height of the cylinder.

splitint

Number of segment the mesh will be split into.

resolutionint

Resolution of the sphere.

create_mesh(starting_position: numpy.ndarray, starting_orientation: Optional[numpy.ndarray] = None) → open3d.cpu.pybind.geometry.TriangleMesh

Create a mesh object defined by the dataclass.

Parameters

starting_positionnp.ndarray shape=(3,)

Starting position of the mesh.

starting_orientationnp.ndarray shape=(3,) (default = None)

Starting orientation of the mesh.

Returns

mesho3d.geometry.TriangleMesh

height: float = 3.0

radius: float = 1.0

resolution: int = 10

split: int = 1

znvis.mesh.mesh module

ZnVis: A Zincwarecode package. License ——- This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html SPDX-License-Identifier: EPL-2.0 Copyright Contributors to the Zincwarecode Project. Contact Information ——————- email: zincwarecode@gmail.com github: https://github.com/zincware web: https://zincwarecode.com/ Citation ——– If you use this module please cite us with: Summary ——- Module for the mesh parent class.

class znvis.mesh.mesh.Mesh(material: znvis.material.material.Material = Material(colour=array([0.23137255, 0.20784314, 0.38039216]), alpha=1.0, roughness=0.5, metallic=0.0, reflectance=0.4, anisotropy=0.4))

Bases: object

Parent class for the ZnVis meshes.

Attributes

materialMaterial

A ZnVis material class.

create_mesh(starting_position: numpy.ndarray, starting_orientation: Optional[numpy.ndarray] = None) → open3d.cpu.pybind.geometry.TriangleMesh

Create a mesh object defined by the dataclass.

Parameters

starting_positionnp.ndarray shape=(3,)

Starting position of the mesh.

starting_orientationnp.ndarray shape=(3,) (default = None)

Starting orientation of the mesh.

Returns

mesho3d.geometry.TriangleMesh

material: znvis.material.material.Material = Material(colour=array([0.23137255, 0.20784314, 0.38039216]), alpha=1.0, roughness=0.5, metallic=0.0, reflectance=0.4, anisotropy=0.4)

znvis.mesh.sphere module

ZnVis: A Zincwarecode package. License ——- This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html SPDX-License-Identifier: EPL-2.0 Copyright Contributors to the Zincwarecode Project. Contact Information ——————- email: zincwarecode@gmail.com github: https://github.com/zincware web: https://zincwarecode.com/ Citation ——– If you use this module please cite us with:

Summary

Create a sphere mesh.

class znvis.mesh.sphere.Sphere(material: znvis.material.material.Material = Material(colour=array([0.23137255, 0.20784314, 0.38039216]), alpha=1.0, roughness=0.5, metallic=0.0, reflectance=0.4, anisotropy=0.4), radius: float = 1.0, resolution: int = 10)

Bases: znvis.mesh.mesh.Mesh

A class to produce sphere meshes.

Attributes

radiusfloat

Radius of the sphere

resolutionint

Resolution of the sphere.

create_mesh(starting_position: numpy.ndarray, starting_orientation: Optional[numpy.ndarray] = None) → open3d.cpu.pybind.geometry.TriangleMesh

Create a mesh object defined by the dataclass.

Parameters

starting_positionnp.ndarray shape=(3,)

Starting position of the mesh.

starting_orientationnp.ndarray shape=(3,) (default = None)

Starting orientation of the mesh.

Returns

mesho3d.geometry.TriangleMesh

radius: float = 1.0

resolution: int = 10

Module contents

ZnVis: A Zincwarecode package. License ——- This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html SPDX-License-Identifier: EPL-2.0 Copyright Contributors to the Zincwarecode Project. Contact Information ——————- email: zincwarecode@gmail.com github: https://github.com/zincware web: https://zincwarecode.com/ Citation ——– If you use this module please cite us with:

Summary

Package for the ZnVis meshes.

class znvis.mesh.Mesh(material: znvis.material.material.Material = Material(colour=array([0.23137255, 0.20784314, 0.38039216]), alpha=1.0, roughness=0.5, metallic=0.0, reflectance=0.4, anisotropy=0.4))

Bases: object

Parent class for the ZnVis meshes.

Attributes

materialMaterial

A ZnVis material class.

create_mesh(starting_position: numpy.ndarray, starting_orientation: Optional[numpy.ndarray] = None) → open3d.cpu.pybind.geometry.TriangleMesh

Create a mesh object defined by the dataclass.

Parameters

starting_positionnp.ndarray shape=(3,)

Starting position of the mesh.

starting_orientationnp.ndarray shape=(3,) (default = None)

Starting orientation of the mesh.

Returns

mesho3d.geometry.TriangleMesh

material: znvis.material.material.Material = Material(colour=array([0.23137255, 0.20784314, 0.38039216]), alpha=1.0, roughness=0.5, metallic=0.0, reflectance=0.4, anisotropy=0.4)