Skip to content

CopickMesh

copick.models.CopickMesh

Encapsulates all data pertaining to a specific mesh. This includes the mesh (trimesh.parent.Geometry) and other metadata.

Attributes:

  • run (CopickRun) –

    Reference to the run this mesh belongs to.

  • meta (CopickMeshMeta) –

    Metadata for this mesh.

  • mesh (Geometry) –

    Mesh for this pick. Either populated from storage or lazily loaded when CopickMesh.mesh is accessed for the first time.

  • from_tool (bool) –

    Flag to indicate if this pick was generated by a tool.

  • from_user (bool) –

    Flag to indicate if this pick was generated by a user.

  • pickable_object_name (str) –

    Pickable object name from CopickConfig.pickable_objects[...].name

  • user_id (str) –

    Unique identifier for the user or tool name.

  • session_id (str) –

    Unique identifier for the pick session

  • color

    Color of the pickable object this pick belongs to.

load() -> Geometry

Load the mesh from storage.

Returns:

  • Geometry

    trimesh.parent.Geometry: The loaded mesh.

store()

Store the mesh.

refresh() -> None

Refresh CopickMesh.mesh from storage.