-Former releases rely on oce (OpenCascade Community Edition), available at
-[oce C++ library / CAD kernel](https://github.com/tpaviot/oce).
+Other pythonocc related resources
+---------------------------------
+* Demos: python examples, as well as jupyter notebooks Xcog=%.3f
Ycog=%.3f
Zcog=%.3f
" % (cog.X(), cog.Y(), cog.Z()) - output += "%s=:%.3f
" % (mass_property, mass) - elif 'Oriented' in selection: - center, dim, oobb_shp = get_oriented_boundingbox(self._current_shape_selection) - self.DisplayShape(oobb_shp, - render_edges=True, - transparency=True, - opacity=0.2, - selectable=False) - output += "OOBB center:
X=%.3f
Y=%.3f
Z=%.3f
" % (center.X(), center.Y(), center.Z()) - output += "OOBB dimensions:
dX=%.3f
dY=%.3f
dZ=%.3f
" % (dim[0], dim[1], dim[2]) - output += "OOBB volume:
V=%.3f
" % (dim[0] * dim[1] * dim[2]) - elif 'Aligned' in selection: - center, dim, albb_shp = get_aligned_boundingbox(self._current_shape_selection) - self.DisplayShape(albb_shp, - render_edges=True, - transparency=True, - opacity=0.2, - selectable=False) - output += "ABB center:
X=%.3f
Y=%.3f
Z=%.3f
" % (center.X(), center.Y(), center.Z()) - output += "ABB dimensions:
dX=%.3f
dY=%.3f
dZ=%.3f
" % (dim[0], dim[1], dim[2]) - output += "ABB volume:
V=%.3f
" % (dim[0] * dim[1] * dim[2]) - elif 'Recognize' in selection: - # try featrue recognition - kind, pnt, vec = recognize_face(self._current_shape_selection) - output += "Type: %s
" % kind - if kind == "Plane": - self.DisplayShape([pnt]) - output += "Properties:
" - output += "Point:
X=%.3f
Y=%.3f
Z=%.3f
" % (pnt.X(), pnt.Y(), pnt.Z()) - output += "Normal:
u=%.3f
v=%.3f
w=%.3f
" % (vec.X(), vec.Y(), vec.Z()) - elif kind == "Cylinder": - self.DisplayShape([pnt]) - output += "Properties:
" - output += "Axis point:
X=%.3f
Y=%.3f
Z=%.3f
" % (pnt.X(), pnt.Y(), pnt.Z()) - output += "Axis direction:
u=%.3f
v=%.3f
w=%.3f
" % (vec.X(), vec.Y(), vec.Z()) - self.html.value = output - - def toggle_shape_visibility(self, *kargs): + def on_compute_change(self, change: Dict[str, Any]) -> None: + """ + Called when the compute dropdown changes. + """ + if change["type"] != "change" or change["name"] != "value": + return + selection = change["new"] + output = "" + if "Inertia" in selection: + cog, mass, mass_property = measure_shape_mass_center_of_gravity( + self._current_shape_selection + ) + # display this point (type gp_Pnt) + self.DisplayShape([cog]) + output += ( + "Center of Gravity:
Xcog=%.3f
Ycog=%.3f
Zcog=%.3f
" + % (cog.X(), cog.Y(), cog.Z()) + ) + output += "%s=:%.3f
" % (mass_property, mass) + elif "Oriented" in selection: + center, dim, oobb_shp = get_oriented_boundingbox( + self._current_shape_selection + ) + self.DisplayShape( + oobb_shp, + render_edges=True, + transparency=True, + opacity=0.2, + selectable=False, + ) + output += ( + "OOBB center:
X=%.3f
Y=%.3f
Z=%.3f
" + % (center.X(), center.Y(), center.Z()) + ) + output += ( + "OOBB dimensions:
dX=%.3f
dY=%.3f
dZ=%.3f
" + % (dim[0], dim[1], dim[2]) + ) + output += "OOBB volume:
V=%.3f
" % ( + dim[0] * dim[1] * dim[2] + ) + elif "Aligned" in selection: + center, dim, albb_shp = get_aligned_boundingbox( + self._current_shape_selection + ) + self.DisplayShape( + albb_shp, + render_edges=True, + transparency=True, + opacity=0.2, + selectable=False, + ) + output += ( + "ABB center:
X=%.3f
Y=%.3f
Z=%.3f
" + % (center.X(), center.Y(), center.Z()) + ) + output += ( + "ABB dimensions:
dX=%.3f
dY=%.3f
dZ=%.3f
" + % (dim[0], dim[1], dim[2]) + ) + output += "ABB volume:
V=%.3f
" % ( + dim[0] * dim[1] * dim[2] + ) + elif "Recognize" in selection: + # try featrue recognition + kind, pnt, vec = recognize_face(self._current_shape_selection) + output += f"Type: {kind}
" + if kind == "Plane": + self.DisplayShape([pnt]) + output += "Properties:
" + output += ( + "Point:
X=%.3f
Y=%.3f
Z=%.3f
" + % (pnt.X(), pnt.Y(), pnt.Z()) + ) + output += ( + "Normal:
u=%.3f
v=%.3f
w=%.3f
" + % (vec.X(), vec.Y(), vec.Z()) + ) + elif kind == "Cylinder": + self.DisplayShape([pnt]) + output += "Properties:
" + output += ( + "Axis point:
X=%.3f
Y=%.3f
Z=%.3f
" + % (pnt.X(), pnt.Y(), pnt.Z()) + ) + output += ( + "Axis direction:
u=%.3f
v=%.3f
w=%.3f
" + % (vec.X(), vec.Y(), vec.Z()) + ) + self.html.value = output + + def toggle_shape_visibility(self, *kargs: Any) -> None: + """ + Toggles the visibility of the selected shape. + """ self.clicked_obj.visible = not self.clicked_obj.visible - def toggle_axes_visibility(self, change): + def toggle_axes_visibility(self, change: Dict[str, Any]) -> None: + """ + Toggles the visibility of the axes. + """ self.axes.set_visibility(_bool_or_new(change)) - def toggle_grid_visibility(self, change): + def toggle_grid_visibility(self, change: Dict[str, Any]) -> None: + """ + Toggles the visibility of the grid. + """ self.horizontal_grid.set_visibility(_bool_or_new(change)) self.vertical_grid.set_visibility(_bool_or_new(change)) - def click(self, value): - """ called whenever a shape or edge is clicked + def click(self, value: Any) -> None: + """ + Called whenever a shape or edge is clicked. + + Args: + value: The clicked object. """ obj = value.owner.object self.clicked_obj = obj if self._current_mesh_selection != obj: if self._current_mesh_selection is not None: - self._current_mesh_selection.material.color = self._current_selection_material_color + self._current_mesh_selection.material.color = ( + self._current_selection_material_color + ) self._current_mesh_selection.material.transparent = False self._current_mesh_selection = None self._current_selection_material_color = None @@ -503,8 +882,10 @@ def click(self, value): obj.material.opacity = 0.5 # get the shape from this mesh id selected_shape = self._shapes[id_clicked] - html_value = "Shape type: %s
" % get_type_as_string(selected_shape) - html_value += "Shape id: %s
" % id_clicked + html_value = "Shape type: %s
" % get_type_as_string( + selected_shape + ) + html_value += f"Shape id: {id_clicked}
" self.html.value = html_value self._current_shape_selection = selected_shape else: @@ -513,72 +894,100 @@ def click(self, value): for callback in self._select_callbacks: callback(self._current_shape_selection) - def register_select_callback(self, callback): - """ Adds a callback that will be called each time a shape is selected + def register_select_callback(self, callback: Callable) -> None: + """ + Adds a callback that will be called each time a shape is selected. + + Args: + callback: The callback to add. """ if not callable(callback): raise AssertionError("You must provide a callable to register the callback") else: self._select_callbacks.append(callback) - def unregister_callback(self, callback): - """ Remove a callback from the callback list + def unregister_callback(self, callback: Callable) -> None: + """ + Removes a callback from the callback list. + + Args: + callback: The callback to remove. """ if callback not in self._select_callbacks: raise AssertionError("This callback is not registered") else: self._select_callbacks.remove(callback) - def GetSelectedShape(self): - """ Returns the selected shape + def GetSelectedShape(self) -> Any: + """ + Returns the selected shape. """ return self._current_shape_selection - def DisplayShapeAsSVG(self, - shp, - export_hidden_edges=True, - location=gp_Pnt(0, 0, 0), - direction=gp_Dir(1, 1, 1), - color="black", - line_width=0.5): - svg_string = export_shape_to_svg(shp, export_hidden_edges=export_hidden_edges, - location=location, direction=direction, - color=color, line_width=line_width, - margin_left=0, margin_top=0) + def DisplayShapeAsSVG( + self, + shp: Any, + export_hidden_edges: bool = True, + location: gp_Pnt = gp_Pnt(0, 0, 0), + direction: gp_Dir = gp_Dir(1, 1, 1), + color: str = "black", + line_width: float = 0.5, + ) -> None: + """ + Displays a shape as an SVG. + + Args: + shp: The shape to display. + export_hidden_edges (bool, optional): Whether to export hidden edges. + location (gp_Pnt, optional): The location of the camera. + direction (gp_Dir, optional): The direction of the camera. + color (str, optional): The color of the shape. + line_width (float, optional): The width of the lines. + """ + svg_string = export_shape_to_svg( + shp, + export_hidden_edges=export_hidden_edges, + location=location, + direction=direction, + color=color, + line_width=line_width, + margin_left=0, + margin_top=0, + ) svg = SVG(data=svg_string) display(svg) - def DisplayShape(self, - shp, - shape_color=None, - render_edges=False, - edge_color=None, - edge_deflection=0.05, - vertex_color=None, - quality=1.0, - transparency=False, - opacity=1., - topo_level='default', - update=False, - selectable=True): - """ Displays a topods_shape in the renderer instance. - shp: the TopoDS_Shape to render - shape_color: the shape color, in html corm, eg '#abe000' - render_edges: optional, False by default. If True, compute and dislay all - edges as a linear interpolation of segments. - edge_color: optional, black by default. The color used for edge rendering, - in html form eg '#ff00ee' - edge_deflection: optional, 0.05 by default - vertex_color: optional - quality: optional, 1.0 by default. If set to something lower than 1.0, - mesh will be more precise. If set to something higher than 1.0, - mesh will be less precise, i.e. lower numer of triangles. - transparency: optional, False by default (opaque). - opacity: optional, float, by default to 1 (opaque). if transparency is set to True, - 0. is fully opaque, 1. is fully transparent. - topo_level: "default" by default. The value should be either "compound", "shape", "vertex". - update: optional, False by default. If True, render all the shapes. - selectable: if True, can be doubleclicked from the 3d window + def DisplayShape( + self, + shp: Any, + shape_color: Optional[str] = None, + render_edges: bool = False, + edge_color: Optional[str] = None, + edge_deflection: float = 0.05, + vertex_color: Optional[str] = None, + quality: float = 1.0, + transparency: bool = False, + opacity: float = 1.0, + topo_level: str = "default", + update: bool = False, + selectable: bool = True, + ) -> None: + """ + Displays a shape in the renderer. + + Args: + shp: The shape to display. + shape_color (str, optional): The color of the shape. + render_edges (bool, optional): Whether to render the edges. + edge_color (str, optional): The color of the edges. + edge_deflection (float, optional): The deflection of the edges. + vertex_color (str, optional): The color of the vertices. + quality (float, optional): The quality of the mesh. + transparency (bool, optional): Whether the shape is transparent. + opacity (float, optional): The opacity of the shape. + topo_level (str, optional): The topological level to display. + update (bool, optional): Whether to update the renderer. + selectable (bool, optional): Whether the shape is selectable. """ if edge_color is None: edge_color = self._default_edge_color @@ -587,7 +996,7 @@ def DisplayShape(self, if vertex_color is None: vertex_color = self._default_vertex_color - output = [] # a list of all geometries created from the shape + output: List[Any] = [] # a list of all geometries created from the shape # is it list of gp_Pnt ? if isinstance(shp, list) and isinstance(shp[0], gp_Pnt): result = self.AddVerticesToScene(shp, vertex_color) @@ -598,29 +1007,60 @@ def DisplayShape(self, output.append(result) elif topo_level != "default": t = TopologyExplorer(shp) - map_type_and_methods = {"Solid": t.solids, "Face": t.faces, "Shell": t.shells, - "Compound": t.compounds, "Compsolid": t.comp_solids} + map_type_and_methods = { + "Solid": t.solids, + "Face": t.faces, + "Shell": t.shells, + "Compound": t.compounds, + "Compsolid": t.comp_solids, + } for subshape in map_type_and_methods[topo_level](): - result = self.AddShapeToScene(subshape, shape_color, render_edges, edge_color, - vertex_color, quality, transparency, opacity) + result = self.AddShapeToScene( + subshape, + shape_color, + render_edges, + edge_color, + vertex_color, + quality, + transparency, + opacity, + ) output.append(result) else: - result = self.AddShapeToScene(shp, shape_color, render_edges, - edge_color, vertex_color, quality, - transparency, opacity) + result = self.AddShapeToScene( + shp, + shape_color, + render_edges, + edge_color, + vertex_color, + quality, + transparency, + opacity, + ) output.append(result) - if selectable:# Add geometries to pickable or non pickable objects + if selectable: # Add geometries to pickable or non pickable objects for elem in output: self._displayed_pickable_objects.add(elem) if update: self.Display() - def AddVerticesToScene(self, pnt_list, vertex_color, vertex_width=5): - """ shp is a list of gp_Pnt + def AddVerticesToScene( + self, pnt_list: List[gp_Pnt], vertex_color: str, vertex_width: int = 5 + ) -> Points: """ - vertices_list = [] # will be passed to pythreejs + Adds a list of vertices to the scene. + + Args: + pnt_list (list): A list of gp_Pnt objects. + vertex_color (str): The color of the vertices. + vertex_width (int, optional): The width of the vertices. Defaults to 5. + + Returns: + The created Points object. + """ + vertices_list: List[List[float]] = [] # will be passed to pythreejs BB = BRep_Builder() compound = TopoDS_Compound() BB.MakeCompound(compound) @@ -632,18 +1072,28 @@ def AddVerticesToScene(self, pnt_list, vertex_color, vertex_width=5): # map the Points and the AIS_PointCloud # and to the dict of shapes, to have a mapping between meshes and shapes - point_cloud_id = "%s" % uuid.uuid4().hex + point_cloud_id = f"{uuid.uuid4().hex}" self._shapes[point_cloud_id] = compound - vertices_list = np.array(vertices_list, dtype=np.float32) - attributes = {"position": BufferAttribute(vertices_list, normalized=False)} - mat = PointsMaterial(color=vertex_color, sizeAttenuation=True, size=vertex_width) + np_vertices_list = np.array(vertices_list, dtype=np.float32) + attributes = {"position": BufferAttribute(np_vertices_list, normalized=False)} + mat = PointsMaterial( + color=vertex_color, sizeAttenuation=True, size=vertex_width + ) geom = BufferGeometry(attributes=attributes) - points = Points(geometry=geom, material=mat, name=point_cloud_id) - return points + return Points(geometry=geom, material=mat, name=point_cloud_id) - def AddCurveToScene(self, shp, edge_color, deflection): - """ shp is either a TopoDS_Wire or a TopodS_Edge. + def AddCurveToScene(self, shp: Any, edge_color: str, deflection: float) -> Line: + """ + Adds a curve to the scene. + + Args: + shp: The curve to add. + edge_color (str): The color of the curve. + deflection (float): The deflection of the curve. + + Returns: + The created Line object. """ if is_edge(shp): pnts = discretize_edge(shp, deflection) @@ -651,41 +1101,52 @@ def AddCurveToScene(self, shp, edge_color, deflection): pnts = discretize_wire(shp, deflection) np_edge_vertices = np.array(pnts, dtype=np.float32) np_edge_indices = np.arange(np_edge_vertices.shape[0], dtype=np.uint32) - edge_geometry = BufferGeometry(attributes={ - 'position': BufferAttribute(np_edge_vertices), - 'index': BufferAttribute(np_edge_indices) - }) + edge_geometry = BufferGeometry( + attributes={ + "position": BufferAttribute(np_edge_vertices), + "index": BufferAttribute(np_edge_indices), + } + ) edge_material = LineBasicMaterial(color=edge_color, linewidth=1) # and to the dict of shapes, to have a mapping between meshes and shapes - edge_id = "%s" % uuid.uuid4().hex + edge_id = f"{uuid.uuid4().hex}" self._shapes[edge_id] = shp - edge_line = Line(geometry=edge_geometry, - material=edge_material, - name=edge_id) - - # and to the dict of shapes, to have a mapping between meshes and shapes - edge_id = "%s" % uuid.uuid4().hex - self._shapes[edge_id] = shp + edge_line = Line(geometry=edge_geometry, material=edge_material, name=edge_id) return edge_line - - def AddShapeToScene(self, - shp, - shape_color=None, # the default - render_edges=False, - edge_color=None, - vertex_color=None, - quality=1.0, - transparency=False, - opacity=1.): - # first, compute the tesselation + def AddShapeToScene( + self, + shp: Any, + shape_color: Optional[str] = None, # the default + render_edges: bool = False, + edge_color: Optional[str] = None, + vertex_color: Optional[str] = None, + quality: float = 1.0, + transparency: bool = False, + opacity: float = 1.0, + ) -> Any: + """ + Adds a shape to the scene. + + Args: + shp: The shape to add. + shape_color (str, optional): The color of the shape. + render_edges (bool, optional): Whether to render the edges. + edge_color (str, optional): The color of the edges. + vertex_color (str, optional): The color of the vertices. + quality (float, optional): The quality of the mesh. + transparency (bool, optional): Whether the shape is transparent. + opacity (float, optional): The opacity of the shape. + + Returns: + The created Mesh object. + """ + # first, compute the tessellation tess = ShapeTesselator(shp) - tess.Compute(compute_edges=render_edges, - mesh_quality=quality, - parallel=True) + tess.Compute(compute_edges=render_edges, mesh_quality=quality, parallel=True) # get vertices and normals vertices_position = tess.GetVerticesPositionAsTuple() @@ -699,45 +1160,59 @@ def AddShapeToScene(self, raise AssertionError("Wrong number of triangles") # then we build the vertex and faces collections as numpy ndarrays - np_vertices = np.array(vertices_position, dtype='float32').reshape(int(number_of_vertices / 3), 3) + np_vertices = np.array(vertices_position, dtype="float32").reshape( + number_of_vertices // 3, 3 + ) # Note: np_faces is just [0, 1, 2, 3, 4, 5, ...], thus arange is used - np_faces = np.arange(np_vertices.shape[0], dtype='uint32') + np_faces = np.arange(np_vertices.shape[0], dtype="uint32") # set geometry properties - buffer_geometry_properties = {'position': BufferAttribute(np_vertices), - 'index': BufferAttribute(np_faces)} + buffer_geometry_properties = { + "position": BufferAttribute(np_vertices), + "index": BufferAttribute(np_faces), + } if self._compute_normals_mode == NORMAL.SERVER_SIDE: # get the normal list, converts to a numpy ndarray. This should not raise # any issue, since normals have been computed by the server, and are available # as a list of floats - np_normals = np.array(tess.GetNormalsAsTuple(), dtype='float32').reshape(-1, 3) + np_normals = np.array(tess.GetNormalsAsTuple(), dtype="float32").reshape( + -1, 3 + ) # quick check if np_normals.shape != np_vertices.shape: raise AssertionError("Wrong number of normals/shapes") - buffer_geometry_properties['normal'] = BufferAttribute(np_normals) + buffer_geometry_properties["normal"] = BufferAttribute(np_normals) # build a BufferGeometry instance shape_geometry = BufferGeometry(attributes=buffer_geometry_properties) # if the client has to render normals, add the related js instructions if self._compute_normals_mode == NORMAL.CLIENT_SIDE: - shape_geometry.exec_three_obj_method('computeVertexNormals') + shape_geometry.exec_three_obj_method("computeVertexNormals") # then a default material - shp_material = self._material(shape_color, transparent=transparency, opacity=opacity) + shp_material = self._material( + shape_color, transparent=transparency, opacity=opacity + ) # and to the dict of shapes, to have a mapping between meshes and shapes - mesh_id = "%s" % uuid.uuid4().hex + mesh_id = f"{uuid.uuid4().hex}" self._shapes[mesh_id] = shp # finally create the mesh - shape_mesh = Mesh(geometry=shape_geometry, - material=shp_material, - name=mesh_id) + shape_mesh = Mesh(geometry=shape_geometry, material=shp_material, name=mesh_id) # edge rendering, if set to True if render_edges: - edges = list(map(lambda i_edge: [tess.GetEdgeVertex(i_edge, i_vert) for i_vert in range(tess.ObjEdgeGetVertexCount(i_edge))], range(tess.ObjGetEdgeCount()))) + edges = list( + map( + lambda i_edge: [ + tess.GetEdgeVertex(i_edge, i_vert) + for i_vert in range(tess.ObjEdgeGetVertexCount(i_edge)) + ], + range(tess.ObjGetEdgeCount()), + ) + ) edge_list = _flatten(list(map(_explode, edges))) lines = LineSegmentsGeometry(positions=edge_list) mat = LineMaterial(linewidth=1, color=edge_color) @@ -746,14 +1221,21 @@ def AddShapeToScene(self, return shape_mesh - def _scale(self, vec): + def _scale(self, vec: List[float]) -> List[float]: + """ + Scales a vector. + """ r = self._bb._max_dist_from_center() * self._camera_distance_factor n = np.linalg.norm(vec) - new_vec = [v / n * r for v in vec] - return new_vec + return [v / n * r for v in vec] - def _material(self, color, transparent=False, opacity=1.0): - #material = MeshPhongMaterial() + def _material( + self, color: str, transparent: bool = False, opacity: float = 1.0 + ) -> CustomMaterial: + """ + Creates a material. + """ + # material = MeshPhongMaterial() material = CustomMaterial("standard") material.color = color material.clipping = True @@ -763,11 +1245,15 @@ def _material(self, color, transparent=False, opacity=1.0): material.polygonOffsetUnits = 1 material.transparent = transparent material.opacity = opacity + material.alpha = opacity material.update("metalness", 0.3) material.update("roughness", 0.8) return material - def EraseAll(self): + def EraseAll(self) -> None: + """ + Erases all shapes from the renderer. + """ self._shapes = {} self._displayed_pickable_objects = Group() self._current_shape_selection = None @@ -775,97 +1261,143 @@ def EraseAll(self): self._current_selection_material = None self._renderer.scene = Scene(children=[]) - def Display(self, position=None, rotation=None): + def Display( + self, + position: Optional[Tuple[float, float, float]] = None, + rotation: Optional[Tuple[float, float, float]] = None, + ) -> None: + """ + Displays the renderer. + + Args: + position (tuple, optional): The position of the camera. + rotation (tuple, optional): The rotation of the camera. + """ # Get the overall bounding box if self._shapes: - self._bb = BoundingBox([self._shapes.values()]) + self._bb = BoundingBox(list(self._shapes.values())) else: # if nothing registered yet, create a fake bb - self._bb = BoundingBox([[BRepPrimAPI_MakeSphere(5.).Shape()]]) + self._bb = BoundingBox([BRepPrimAPI_MakeSphere(5.0).Shape()]) bb_max = self._bb.max orbit_radius = 1.5 * self._bb._max_dist_from_center() # Set up camera camera_target = self._bb.center - camera_position = _add(self._bb.center, - self._scale([1, 1, 1] if position is None else self._scale(position))) + camera_position = _add( + self._bb.center, + self._scale([1, 1, 1] if position is None else self._scale(position)), + ) camera_zoom = self._camera_initial_zoom - self._camera = CombinedCamera(position=camera_position, - width=self._size[0], height=self._size[1]) + self._camera = CombinedCamera( + position=camera_position, width=self._size[0], height=self._size[1] + ) self._camera.up = (0.0, 0.0, 1.0) - self._camera.mode = 'orthographic' + self._camera.mode = "orthographic" self._camera_target = camera_target self._camera.position = camera_position if rotation is not None: self._camera.rotation = rotation # Set up lights in every of the 8 corners of the global bounding box positions = list(itertools.product(*[(-orbit_radius, orbit_radius)] * 3)) - key_lights = [DirectionalLight(color='white', - position=pos, - intensity=0.5) for pos in positions] + key_lights = [ + DirectionalLight(color="white", position=pos, intensity=0.5) + for pos in positions + ] ambient_light = AmbientLight(intensity=0.1) # Set up Helpers self.axes = Axes(bb_center=self._bb.center, length=bb_max * 1.1) - self.horizontal_grid = Grid(bb_center=self._bb.center, maximum=bb_max, - colorCenterLine='#aaa', colorGrid='#ddd') - self.vertical_grid = Grid(bb_center=self._bb.center, maximum=bb_max, - colorCenterLine='#aaa', colorGrid='#ddd') + self.horizontal_grid = Grid( + bb_center=self._bb.center, + maximum=bb_max, + colorCenterLine="#aaa", + colorGrid="#ddd", + ) + self.vertical_grid = Grid( + bb_center=self._bb.center, + maximum=bb_max, + colorCenterLine="#aaa", + colorGrid="#ddd", + ) # Set up scene - environment = self.axes.axes + key_lights + [ambient_light, - self.horizontal_grid.grid, - self.vertical_grid.grid, - self._camera] - - scene_shp = Scene(children=[self._displayed_pickable_objects, - self._displayed_non_pickable_objects] + environment) + environment = ( + self.axes.axes + + key_lights + + [ + ambient_light, + self.horizontal_grid.grid, + self.vertical_grid.grid, + self._camera, + ] + ) + + scene_shp = Scene( + children=[ + self._displayed_pickable_objects, + self._displayed_non_pickable_objects, + ] + + environment + ) # Set up Controllers - self._controller = OrbitControls(controlling=self._camera, - target=camera_target, - target0=camera_target) + self._controller = OrbitControls(controlling=self._camera, target=camera_target) # Update controller to instantiate camera position self._camera.zoom = camera_zoom self._update() # setup Picker - self._picker = Picker(controlling=self._displayed_pickable_objects, event='dblclick') + self._picker = Picker( + controlling=self._displayed_pickable_objects, event="dblclick" + ) self._picker.observe(self.click) - self._renderer = Renderer(camera=self._camera, - background=self._background, - background_opacity=self._background_opacity, - scene=scene_shp, - controls=[self._controller, self._picker], - width=self._size[0], - height=self._size[1], - antialias=True) + self._renderer = Renderer( + camera=self._camera, + background=self._background, + background_opacity=self._background_opacity, + scene=scene_shp, + controls=[self._controller, self._picker], + width=self._size[0], + height=self._size[1], + antialias=True, + ) # set rotation and position for each grid self.horizontal_grid.set_position((0, 0, 0)) self.horizontal_grid.set_rotation((math.pi / 2.0, 0, 0, "XYZ")) - self.vertical_grid.set_position((0, - bb_max, 0)) + self.vertical_grid.set_position((0, -bb_max, 0)) self._savestate = (self._camera.rotation, self._controller.target) # then display both 3d widgets and webui - display(HBox([VBox([HBox(self._controls), self._renderer]), - self.html])) + display(HBox([VBox([HBox(self._controls), self._renderer]), self.html])) + def ExportToHTML(self, filename: str) -> None: + """ + Exports the renderer to an HTML file. - def ExportToHTML(self, filename): - embed.embed_minimal_html(filename, views=self._renderer, title='pythonocc') + Args: + filename (str): The name of the file to export to. + """ + embed.embed_minimal_html(filename, views=self._renderer, title="pythonocc") - def _reset(self, *kargs): + def _reset(self, *kargs: Any) -> None: + """ + Resets the camera. + """ self._camera.rotation, self._controller.target = self._savestate self._camera.position = _add(self._bb.center, self._scale((1, 1, 1))) self._camera.zoom = self._camera_initial_zoom self._update() - def _update(self): - self._controller.exec_three_obj_method('update') + def _update(self) -> None: + """ + Updates the controller. + """ + self._controller.exec_three_obj_method("update") - def __repr__(self): + def __repr__(self) -> str: self.Display() return "" diff --git a/src/Display/WebGl/jupyter_renderer.pyi b/src/Display/WebGl/jupyter_renderer.pyi new file mode 100644 index 000000000..e1e167108 --- /dev/null +++ b/src/Display/WebGl/jupyter_renderer.pyi @@ -0,0 +1,158 @@ +from typing import Any, Callable, Dict, List, Optional, Tuple, Union + +from OCC.Core.gp import gp_Dir, gp_Pnt +from pythreejs import ( + Button, + Checkbox, + Line, + Points, + ShaderMaterial, +) + +def _add(vec1: List[float], vec2: List[float]) -> List[float]: ... +def _explode(edge_list: List[List[float]]) -> List[List[List[float]]]: ... +def _flatten(nested_dict: Dict[Any, Any]) -> List[Any]: ... +def format_color(r: int, g: int, b: int) -> str: ... +def _distance(v1: List[float], v2: List[float]) -> float: ... +def _bool_or_new(val: Union[bool, Dict[str, Any]]) -> bool: ... +def _opt(b1: Tuple[float, ...], b2: Tuple[float, ...]) -> Tuple[float, ...]: ... +def _shift(v: List[float], offset: List[float]) -> List[float]: ... +def _nice_number(value: float, round_: bool = False) -> float: ... +def _nice_bounds( + axis_start: float, axis_end: float, num_ticks: int = 10 +) -> Tuple[float, float, float]: ... + +class Helpers: + def __init__(self, bb_center: Tuple[float, float, float]) -> None: ... + def _center(self, zero: bool = True) -> Tuple[float, float, float]: ... + def set_position(self, position: Tuple[float, float, float]) -> None: ... + def set_visibility(self, change: bool) -> None: ... + def set_center(self, change: bool) -> None: ... + +class Grid(Helpers): + def __init__( + self, + bb_center: Optional[Tuple[float, float, float]] = None, + maximum: int = 5, + ticks: int = 10, + colorCenterLine: str = "#aaa", + colorGrid: str = "#ddd", + ) -> None: ... + def set_position(self, position: Tuple[float, float, float]) -> None: ... + def set_visibility(self, change: bool) -> None: ... + def set_rotation(self, rotation: Tuple[float, float, float, str]) -> None: ... + +class Axes(Helpers): + def __init__( + self, + bb_center: Tuple[float, float, float], + length: int = 1, + width: int = 3, + display_labels: bool = False, + ) -> None: ... + def set_position(self, position: Tuple[float, float, float]) -> None: ... + def set_visibility(self, change: bool) -> None: ... + +class CustomMaterial(ShaderMaterial): + def __init__(self, typ: str) -> None: ... + @property + def color(self) -> str: ... + @color.setter + def color(self, value: str) -> None: ... + @property + def alpha(self) -> float: ... + @alpha.setter + def alpha(self, value: float) -> None: ... + def update(self, key: str, value: Any) -> None: ... + +class BoundingBox: + def __init__(self, objects: List[Any], tol: float = 1e-5) -> None: ... + def _max_dist_from_center(self) -> float: ... + def _max_dist_from_origin(self) -> float: ... + def _bounding_box(self, obj: Any, tol: float = 1e-5) -> Tuple[float, ...]: ... + def _bbox(self, objects: List[Any]) -> Tuple[float, ...]: ... + def __repr__(self) -> str: ... + +class NORMAL: + SERVER_SIDE: int + CLIENT_SIDE: int + +class JupyterRenderer: + def __init__( + self, + size: Tuple[int, int] = (640, 480), + compute_normals_mode: int = ..., + default_shape_color: str = ..., + default_edge_color: str = ..., + default_vertex_color: str = ..., + pick_color: str = ..., + background_color: str = "white", + ) -> None: ... + def create_button( + self, description: str, tooltip: str, disabled: bool, handler: Callable + ) -> Button: ... + def create_checkbox( + self, kind: str, description: str, value: bool, handler: Callable + ) -> Checkbox: ... + def remove_shape(self, *kargs: Any) -> None: ... + def on_compute_change(self, change: Dict[str, Any]) -> None: ... + def toggle_shape_visibility(self, *kargs: Any) -> None: ... + def toggle_axes_visibility(self, change: Dict[str, Any]) -> None: ... + def toggle_grid_visibility(self, change: Dict[str, Any]) -> None: ... + def click(self, value: Any) -> None: ... + def register_select_callback(self, callback: Callable) -> None: ... + def unregister_callback(self, callback: Callable) -> None: ... + def GetSelectedShape(self) -> Any: ... + def DisplayShapeAsSVG( + self, + shp: Any, + export_hidden_edges: bool = True, + location: gp_Pnt = ..., + direction: gp_Dir = ..., + color: str = "black", + line_width: float = 0.5, + ) -> None: ... + def DisplayShape( + self, + shp: Any, + shape_color: Optional[str] = None, + render_edges: bool = False, + edge_color: Optional[str] = None, + edge_deflection: float = 0.05, + vertex_color: Optional[str] = None, + quality: float = 1.0, + transparency: bool = False, + opacity: float = 1.0, + topo_level: str = "default", + update: bool = False, + selectable: bool = True, + ) -> None: ... + def AddVerticesToScene( + self, pnt_list: List[gp_Pnt], vertex_color: str, vertex_width: int = 5 + ) -> Points: ... + def AddCurveToScene(self, shp: Any, edge_color: str, deflection: float) -> Line: ... + def AddShapeToScene( + self, + shp: Any, + shape_color: Optional[str] = None, + render_edges: bool = False, + edge_color: Optional[str] = None, + vertex_color: Optional[str] = None, + quality: float = 1.0, + transparency: bool = False, + opacity: float = 1.0, + ) -> Any: ... + def _scale(self, vec: List[float]) -> List[float]: ... + def _material( + self, color: str, transparent: bool = False, opacity: float = 1.0 + ) -> CustomMaterial: ... + def EraseAll(self) -> None: ... + def Display( + self, + position: Optional[Tuple[float, float, float]] = None, + rotation: Optional[Tuple[float, float, float]] = None, + ) -> None: ... + def ExportToHTML(self, filename: str) -> None: ... + def _reset(self, *kargs: Any) -> None: ... + def _update(self) -> None: ... + def __repr__(self) -> str: ... diff --git a/src/Display/WebGl/simple_server.py b/src/Display/WebGl/simple_server.py index 48dac94d6..cdaff653c 100644 --- a/src/Display/WebGl/simple_server.py +++ b/src/Display/WebGl/simple_server.py @@ -15,7 +15,7 @@ ##You should have received a copy of the GNU Lesser General Public License ##along with pythonOCC. If not, see
pythonocc-{{ occ_version }} three.js {{ threejs_version }} renderer
-
Check our blog at - http://www.pythonocc.org
Check our blog at - http://www.pythonocc.org
t view/hide shape
diff --git a/src/Display/WebGl/threejs_renderer.py b/src/Display/WebGl/threejs_renderer.py index 4fd12a744..167905b82 100644 --- a/src/Display/WebGl/threejs_renderer.py +++ b/src/Display/WebGl/threejs_renderer.py @@ -1,4 +1,4 @@ -##Copyright 2011-2019 Thomas Paviot (tpaviot@gmail.com) +##Copyright 2011-2024 Thomas Paviot (tpaviot@gmail.com) ## ##This file is part of pythonOCC. ## @@ -15,72 +15,98 @@ ##You should have received a copy of the GNU Lesser General Public License ##along with pythonOCC. If not, seepythonocc @VERSION@ webgl renderer
+ pythonocc $VERSION webgl renderer
"""
-BODY_PART0 = """
-
+)
+
+BODY_TEMPLATE = Template(
+ """
+
-
-
-
-
+
+
+
+
-""" % (OCC_VERSION, OCC_VERSION, OCC_VERSION)
+"""
+)
-HEADER = """
+HEADER_TEMPLATE = Template(
+ """
- pythonOCC @VERSION@ x3dom renderer
+ pythonOCC $VERSION x3dom renderer
@@ -54,7 +63,7 @@ def spinning_cursor():
"""
+)
-BODY = """
+BODY_TEMPLATE = Template(
+ """
- @X3DSCENE@
+ $X3DSCENE
diff --git a/src/Display/WebGl/threejs_renderer.py b/src/Display/WebGl/threejs_renderer.py index 4fd12a744..167905b82 100644 --- a/src/Display/WebGl/threejs_renderer.py +++ b/src/Display/WebGl/threejs_renderer.py @@ -1,4 +1,4 @@ -##Copyright 2011-2019 Thomas Paviot (tpaviot@gmail.com) +##Copyright 2011-2024 Thomas Paviot (tpaviot@gmail.com) ## ##This file is part of pythonOCC. ## @@ -15,72 +15,98 @@ ##You should have received a copy of the GNU Lesser General Public License ##along with pythonOCC. If not, see
- pythonocc-@VERSION@ three.js %s renderer
-
Check our blog at - http://www.pythonocc.org + pythonocc-$VERSION three.js renderer
Check our blog at - http://www.pythonocc.org + pythonocc-$VERSION three.js renderer
t view/hide shape
@@ -140,291 +167,326 @@ def export_edgedata_to_json(edge_hash, point_set): g view/hide grid
a view/hide axis
-
-
-
-
-""" % (THREEJS_RELEASE, THREEJS_RELEASE, THREEJS_RELEASE, THREEJS_RELEASE)
-
-BODY_PART1 = """
-
- @VertexShaderDefinition@
- @FragmentShaderDefinition@
-
+
+
+
+"""
+)
+
+MAIN_JS_TEMPLATE = Template(
+ """
+import * as THREE from 'three';
+import { TrackballControls } from 'three/addons/controls/TrackballControls.js';
+
+var camera, scene, renderer, object, container, shape_material;
+var controls;
+var directionalLight;
+var axisHelper, gridHelper;
+var light1;
+var mouse;
+var mouseX = 0;
+var mouseXOnMouseDown = 0;
+var mouseY = 0;
+var mouseYOnMouseDown = 0;
+var moveForward = false;
+var moveBackward = false;
+var moveLeft = false;
+var moveRight = false;
+var moveUp = false;
+var moveDown = false;
+var raycaster;
+var windowHalfX = window.innerWidth / 2;
+var windowHalfY = window.innerHeight / 2;
+var selected_target_color_r = 0;
+var selected_target_color_g = 0;
+var selected_target_color_b = 0;
+var selected_target = null;
+init();
+animate();
+
+function init() {
+ container = document.createElement( 'div' );
+ document.body.appendChild( container );
+
+ camera = new THREE.PerspectiveCamera(50, window.innerWidth / window.innerHeight, 1, 200);
+ camera.position.z = 100;
+
+ raycaster = new THREE.Raycaster();
+ mouse = new THREE.Vector2();
+
+ scene = new THREE.Scene();
+ scene.background = new THREE.Color(0xf0f0f0);
+ const ambientLight = new THREE.AmbientLight(0x404040, 1.5);
+ scene.add(ambientLight);
+
+ directionalLight = new THREE.DirectionalLight(0xffffff, 1);
+ directionalLight.position.set(1, 1, 1).normalize();
+ scene.add(directionalLight);
+
+ light1 = new THREE.PointLight(0xffffff, 0.8);
+ light1.position.set(50, 50, 50);
+ scene.add(light1);
+
+ $Uniforms
+
+ $ShaderMaterialDefinition
+
+ $ShapeList
+
+ $EdgeList
+
+ renderer = new THREE.WebGLRenderer({antialias:true, alpha: true});
+ renderer.setSize(window.innerWidth, window.innerHeight);
+ renderer.setPixelRatio( window.devicePixelRatio );
+ container.appendChild(renderer.domElement);
+
+ // shadow rendering
+ renderer.shadowMap.enabled = true;
+ renderer.shadowMap.type = THREE.PCFSoftShadowMap;
+
+ // tone mapping
+ renderer.toneMapping = THREE.ACESFilmicToneMapping;
+ renderer.toneMappingExposure = 1.0;
+ renderer.outputColorSpace = THREE.SRGBColorSpace;
+
+ controls = new TrackballControls(camera, renderer.domElement);
+
+ document.addEventListener('keypress', onDocumentKeyPress, false);
+ document.addEventListener('click', onDocumentMouseClick, false);
+ window.addEventListener('resize', onWindowResize, false);
+}
+
+function animate() {
+ requestAnimationFrame(animate);
+ controls.update();
+ render();
+}
+
+function update_lights() {
+ if (directionalLight != undefined) {
+ directionalLight.position.copy(camera.position);
+ }
+}
+
+function onWindowResize() {
+ camera.aspect = window.innerWidth / window.innerHeight;
+ camera.updateProjectionMatrix();
+ renderer.setSize(window.innerWidth, window.innerHeight);
+}
+
+function onDocumentKeyPress(event) {
+ event.preventDefault();
+ if (event.key=="t") { // t key
+ if (selected_target) {
+ selected_target.material.visible = !selected_target.material.visible;
}
- function onDocumentMouseClick(event) {
- event.preventDefault();
- mouse.x = ( event.clientX / window.innerWidth ) * 2 - 1;
- mouse.y = - ( event.clientY / window.innerHeight ) * 2 + 1;
- // restore previous selected target color
- if (selected_target) {
- selected_target.material.color.setRGB(selected_target_color_r,
- selected_target_color_g,
- selected_target_color_b);
- }
- // perform selection
- raycaster.setFromCamera(mouse, camera);
- var intersects = raycaster.intersectObjects(scene.children);
- if (intersects.length > 0) {
- var target = intersects[0].object;
- selected_target_color_r = target.material.color.r;
- selected_target_color_g = target.material.color.g;
- selected_target_color_b = target.material.color.b;
- target.material.color.setRGB(1., 0.65, 0.);
- console.log(target);
- selected_target = target;
- }
+ }
+ else if (event.key=="g") { // g key, toggle grid visibility
+ gridHelper.visible = !gridHelper.visible;
+ }
+ else if (event.key=="a") { // g key, toggle axisHelper visibility
+ axisHelper.visible = !axisHelper.visible;
+ }
+ else if (event.key=="w") { // g key, toggle axisHelper visibility
+ if (selected_target) {
+ selected_target.material.wireframe = !selected_target.material.wireframe;
}
- function fit_to_scene() {
- // compute bounding sphere of whole scene
- var center = new THREE.Vector3(0,0,0);
- var radiuses = new Array();
- var positions = new Array();
- // compute center of all objects
- scene.traverse(function(child) {
- if (child instanceof THREE.Mesh) {
- child.geometry.computeBoundingBox();
- var box = child.geometry.boundingBox;
- var curCenter = new THREE.Vector3().copy(box.min).add(box.max).multiplyScalar(0.5);
- var radius = new THREE.Vector3().copy(box.max).distanceTo(box.min)/2.;
- center.add(curCenter);
- positions.push(curCenter);
- radiuses.push(radius);
- }
- });
- if (radiuses.length > 0) {
- center.divideScalar(radiuses.length*0.7);
- }
- var maxRad = 1.;
- // compute bounding radius
- for (var ichild = 0; ichild < radiuses.length; ++ichild) {
- var distToCenter = positions[ichild].distanceTo(center);
- var totalDist = distToCenter + radiuses[ichild];
- if (totalDist > maxRad) {
- maxRad = totalDist;
- }
- }
- maxRad = maxRad * 0.7; // otherwise the scene seems to be too far away
- camera.lookAt(center);
- var direction = new THREE.Vector3().copy(camera.position).sub(controls.target);
- var len = direction.length();
- direction.normalize();
-
- // compute new distance of camera to middle of scene to fit the object to screen
- var lnew = maxRad / Math.sin(camera.fov/180. * Math.PI / 2.);
- direction.multiplyScalar(lnew);
-
- var pnew = new THREE.Vector3().copy(center).add(direction);
- // change near far values to avoid culling of objects
- camera.position.set(pnew.x, pnew.y, pnew.z);
- camera.far = lnew*50;
- camera.near = lnew*50*0.001;
- camera.updateProjectionMatrix();
- controls.target = center;
- controls.update();
- // adds and adjust a grid helper if needed
- gridHelper = new THREE.GridHelper(maxRad*4, 10)
- scene.add(gridHelper);
- // axisHelper
- axisHelper = new THREE.AxesHelper(maxRad);
- scene.add(axisHelper);
+ }
+}
+
+function onDocumentMouseClick(event) {
+ event.preventDefault();
+ mouse.x = ( event.clientX / window.innerWidth ) * 2 - 1;
+ mouse.y = - ( event.clientY / window.innerHeight ) * 2 + 1;
+ // restore previous selected target color
+ if (selected_target) {
+ selected_target.material.color.setRGB(selected_target_color_r,
+ selected_target_color_g,
+ selected_target_color_b);
+ }
+ // perform selection
+ raycaster.setFromCamera(mouse, camera);
+ var intersects = raycaster.intersectObjects(scene.children);
+ if (intersects.length > 0) {
+ var target = intersects[0].object;
+ selected_target_color_r = target.material.color.r;
+ selected_target_color_g = target.material.color.g;
+ selected_target_color_b = target.material.color.b;
+ target.material.color.setRGB(1., 0.65, 0.);
+ console.log(target);
+ selected_target = target;
+ }
+}
+
+function fit_to_scene() {
+ // compute bounding sphere of whole scene
+ var center = new THREE.Vector3(0,0,0);
+ var radiuses = new Array();
+ var positions = new Array();
+
+ // compute center of all objects
+ scene.traverse(function(child) {
+ if (child instanceof THREE.Mesh) {
+ child.geometry.computeBoundingBox();
+ var box = child.geometry.boundingBox;
+ var curCenter = new THREE.Vector3().copy(box.min).add(box.max).multiplyScalar(0.5);
+ var radius = new THREE.Vector3().copy(box.max).distanceTo(box.min)/2.;
+ center.add(curCenter);
+ positions.push(curCenter);
+ radiuses.push(radius);
}
- function render() {
- //@IncrementTime@ TODO UNCOMMENT
- update_lights();
- renderer.render(scene, camera);
+ });
+
+ if (radiuses.length > 0) {
+ center.divideScalar(radiuses.length*0.7);
+ }
+
+ var maxRad = 1.;
+ // compute bounding radius
+ for (var ichild = 0; ichild < radiuses.length; ++ichild) {
+ var distToCenter = positions[ichild].distanceTo(center);
+ var totalDist = distToCenter + radiuses[ichild];
+ if (totalDist > maxRad) {
+ maxRad = totalDist;
}
-
-
+ }
+
+ maxRad = maxRad * 0.7; // otherwise the scene seems to be too far away
+ camera.lookAt(center);
+ var direction = new THREE.Vector3().copy(camera.position).sub(controls.target);
+ var len = direction.length();
+ direction.normalize();
+
+ // compute new distance of camera to middle of scene to fit the object to screen
+ var lnew = maxRad / Math.sin(camera.fov/180. * Math.PI / 2.);
+ direction.multiplyScalar(lnew);
+
+ var pnew = new THREE.Vector3().copy(center).add(direction);
+ // change near far values to avoid culling of objects
+ camera.position.set(pnew.x, pnew.y, pnew.z);
+ camera.far = lnew * 50;
+ camera.near = lnew * 50 * 0.001;
+ camera.updateProjectionMatrix();
+ controls.target = center;
+ controls.update();
+
+ // adds and adjust a grid helper if needed
+ gridHelper = new THREE.GridHelper(maxRad*4, 10)
+ scene.add(gridHelper);
+
+ // axisHelper
+ axisHelper = new THREE.AxesHelper(maxRad);
+ scene.add(axisHelper);
+}
+
+function render() {
+ //@IncrementTime@ TODO UNCOMMENT
+ update_lights();
+ renderer.render(scene, camera);
+}
"""
+)
class HTMLHeader:
- def __init__(self, bg_gradient_color1="#ced7de", bg_gradient_color2="#808080"):
+ """
+ A class to generate the HTML header.
+ """
+
+ def __init__(
+ self, bg_gradient_color1: str = "#ced7de", bg_gradient_color2: str = "#808080"
+ ) -> None:
+ """
+ Initializes the HTMLHeader.
+
+ Args:
+ bg_gradient_color1 (str, optional): The first color of the background gradient.
+ bg_gradient_color2 (str, optional): The second color of the background gradient.
+ """
self._bg_gradient_color1 = bg_gradient_color1
self._bg_gradient_color2 = bg_gradient_color2
- def get_str(self):
- header_str = HEADER.replace('@bg_gradient_color1@', '%s' % self._bg_gradient_color1)
- header_str = header_str.replace('@bg_gradient_color2@', '%s' % self._bg_gradient_color2)
- header_str = header_str.replace('@VERSION@', OCC_VERSION)
- return header_str
-
-
-class HTMLBody_Part1:
- def __init__(self, vertex_shader=None, fragment_shader=None, uniforms=None):
- self._vertex_shader = vertex_shader
- self._fragment_shader = fragment_shader
- self._uniforms = uniforms
-
- def get_str(self):
- global BODY_PART2
- # get the location where pythonocc is running from
- body_str = BODY_PART1.replace('@VERSION@', OCC_VERSION)
- if (self._fragment_shader is not None) and (self._fragment_shader is not None):
- vertex_shader_string_definition = '' % self._vertex_shader
- fragment_shader_string_definition = '' % self._fragment_shader
- shader_material_definition = """
- var vertexShader = document.getElementById('vertexShader').textContent;
- var fragmentShader = document.getElementById('fragmentShader').textContent;
- var shader_material = new THREE.ShaderMaterial({uniforms: uniforms,
- vertexShader: vertexShader,
- fragmentShader: fragmentShader});
- """
- if self._uniforms is None:
- body_str = body_str.replace('@Uniforms@', 'uniforms ={};\n')
- BODY_PART2 = BODY_PART2.replace('@IncrementTime@', '')
- else:
- body_str = body_str.replace('@Uniforms@', self._uniforms)
- if 'time' in self._uniforms:
- BODY_PART2 = BODY_PART2.replace('@IncrementTime@', 'uniforms.time.value += 0.05;')
- else:
- BODY_PART2 = BODY_PART2.replace('@IncrementTime@', '')
- body_str = body_str.replace('@VertexShaderDefinition@', vertex_shader_string_definition)
- body_str = body_str.replace('@FragmentShaderDefinition@', fragment_shader_string_definition)
- body_str = body_str.replace('@ShaderMaterialDefinition@', shader_material_definition)
- body_str = body_str.replace('@ShapeMaterial@', 'shader_material')
- else:
- body_str = body_str.replace('@Uniforms@', '')
- body_str = body_str.replace('@VertexShaderDefinition@', '')
- body_str = body_str.replace('@FragmentShaderDefinition@', '')
- body_str = body_str.replace('@ShaderMaterialDefinition@', '')
- body_str = body_str.replace('@ShapeMaterial@', 'phong_material')
- body_str = body_str.replace('@IncrementTime@', '')
- return body_str
+ def get_str(self) -> str:
+ """
+ Returns the HTML header as a string.
+ """
+ return HEADER_TEMPLATE.substitute(
+ {
+ "bg_gradient_color1": f"{self._bg_gradient_color1}",
+ "bg_gradient_color2": f"{self._bg_gradient_color2}",
+ "VERSION": VERSION,
+ }
+ )
class ThreejsRenderer:
- def __init__(self, path=None):
- if not path:
- self._path = tempfile.mkdtemp()
- else:
- self._path = path
+ """
+ A renderer that uses three.js to display shapes in a web browser.
+ """
+
+ def __init__(self, path: Optional[str] = None) -> None:
+ """
+ Initializes the ThreejsRenderer.
+
+ Args:
+ path (str, optional): The path to the directory where the HTML
+ and JavaScript files will be created. If not specified, a
+ temporary directory will be created.
+ """
+ self._path = tempfile.mkdtemp() if not path else path
self._html_filename = os.path.join(self._path, "index.html")
- self._3js_shapes = {}
- self._3js_edges = {}
+ self._main_js_filename = os.path.join(self._path, "main.js")
+ self._3js_shapes: Dict[str, Any] = {}
+ self._3js_edges: Dict[str, Any] = {}
self.spinning_cursor = spinning_cursor()
- print("## threejs %s webgl renderer" % THREEJS_RELEASE)
-
- def DisplayShape(self,
- shape,
- export_edges=False,
- color=(0.65, 0.65, 0.7),
- specular_color=(0.2, 0.2, 0.2),
- shininess=0.9,
- transparency=0.,
- line_color=(0, 0., 0.),
- line_width=1.,
- mesh_quality=1.):
+ print("## threejs renderer")
+
+ def DisplayShape(
+ self,
+ shape: Any,
+ export_edges: bool = False,
+ color: Tuple[float, float, float] = (0.65, 0.65, 0.7),
+ specular_color: Tuple[float, float, float] = (0.2, 0.2, 0.2),
+ shininess: float = 0.9,
+ transparency: float = 0.0,
+ line_color: Tuple[float, float, float] = (0, 0.0, 0.0),
+ line_width: float = 1.0,
+ mesh_quality: float = 1.0,
+ ) -> Tuple[Dict[str, Any], Dict[str, Any]]:
+ """
+ Displays a shape.
+
+ Args:
+ shape: The shape to display.
+ export_edges (bool, optional): Whether to export the edges of the shape.
+ color (tuple, optional): The color of the shape.
+ specular_color (tuple, optional): The specular color of the shape.
+ shininess (float, optional): The shininess of the shape.
+ transparency (float, optional): The transparency of the shape.
+ line_color (tuple, optional): The color of the lines.
+ line_width (float, optional): The width of the lines.
+ mesh_quality (float, optional): The quality of the mesh.
+
+ Returns:
+ A tuple containing the shapes and edges.
+ """
# if the shape is an edge or a wire, use the related functions
if is_edge(shape):
print("discretize an edge")
pnts = discretize_edge(shape)
- edge_hash = "edg%s" % uuid.uuid4().hex
+ edge_hash = f"edg{uuid.uuid4().hex}"
str_to_write = export_edgedata_to_json(edge_hash, pnts)
- edge_full_path = os.path.join(self._path, edge_hash + '.json')
+ edge_full_path = os.path.join(self._path, f"{edge_hash}.json")
with open(edge_full_path, "w") as edge_file:
edge_file.write(str_to_write)
# store this edge hash
@@ -433,34 +495,42 @@ def DisplayShape(self,
elif is_wire(shape):
print("discretize a wire")
pnts = discretize_wire(shape)
- wire_hash = "wir%s" % uuid.uuid4().hex
+ wire_hash = f"wir{uuid.uuid4().hex}"
str_to_write = export_edgedata_to_json(wire_hash, pnts)
- wire_full_path = os.path.join(self._path, wire_hash + '.json')
+ wire_full_path = os.path.join(self._path, f"{wire_hash}.json")
with open(wire_full_path, "w") as wire_file:
wire_file.write(str_to_write)
# store this edge hash
self._3js_edges[wire_hash] = [color, line_width]
return self._3js_shapes, self._3js_edges
shape_uuid = uuid.uuid4().hex
- shape_hash = "shp%s" % shape_uuid
- # tesselate
+ shape_hash = f"shp{shape_uuid}"
+ # tesselatte
tess = ShapeTesselator(shape)
- tess.Compute(compute_edges=export_edges,
- mesh_quality=mesh_quality,
- parallel=True)
+ tess.Compute(
+ compute_edges=export_edges, mesh_quality=mesh_quality, parallel=True
+ )
# update spinning cursor
- sys.stdout.write("\r%s mesh shape %s, %i triangles " % (next(self.spinning_cursor),
- shape_hash,
- tess.ObjGetTriangleCount()))
+ sys.stdout.write(
+ "\r%s mesh shape %s, %i triangles "
+ % (next(self.spinning_cursor), shape_hash, tess.ObjGetTriangleCount())
+ )
sys.stdout.flush()
# export to 3JS
- shape_full_path = os.path.join(self._path, shape_hash + '.json')
+ shape_full_path = os.path.join(self._path, f"{shape_hash}.json")
# add this shape to the shape dict, sotres everything related to it
- self._3js_shapes[shape_hash] = [export_edges, color, specular_color, shininess, transparency, line_color, line_width]
+ self._3js_shapes[shape_hash] = [
+ export_edges,
+ color,
+ specular_color,
+ shininess,
+ transparency,
+ line_color,
+ line_width,
+ ]
# generate the mesh
- #tess.ExportShapeToThreejs(shape_hash, shape_full_path)
# and also to JSON
- with open(shape_full_path, 'w') as json_file:
+ with open(shape_full_path, "w") as json_file:
json_file.write(tess.ExportShapeToThreejsJSONString(shape_uuid))
# draw edges if necessary
if export_edges:
@@ -469,108 +539,155 @@ def DisplayShape(self,
nbr_edges = tess.ObjGetEdgeCount()
for i_edge in range(nbr_edges):
# after that, the file can be appended
- str_to_write = ''
- edge_point_set = []
+ str_to_write = ""
nbr_vertices = tess.ObjEdgeGetVertexCount(i_edge)
- for i_vert in range(nbr_vertices):
- edge_point_set.append(tess.GetEdgeVertex(i_edge, i_vert))
+ edge_point_set = [
+ tess.GetEdgeVertex(i_edge, i_vert) for i_vert in range(nbr_vertices)
+ ]
# write to file
- edge_hash = "edg%s" % uuid.uuid4().hex
+ edge_hash = f"edg{uuid.uuid4().hex}"
str_to_write += export_edgedata_to_json(edge_hash, edge_point_set)
# create the file
- edge_full_path = os.path.join(self._path, edge_hash + '.json')
+ edge_full_path = os.path.join(self._path, f"{edge_hash}.json")
with open(edge_full_path, "w") as edge_file:
edge_file.write(str_to_write)
# store this edge hash, with black color
self._3js_edges[edge_hash] = [(0, 0, 0), line_width]
return self._3js_shapes, self._3js_edges
-
- def generate_html_file(self):
- """ Generate the HTML file to be rendered by the web browser
+ def generate_html_file(self) -> None:
+ """
+ Generates the HTML file to be rendered by the web browser.
"""
- global BODY_PART0
+ global BODY_TEMPLATE
# loop over shapes to generate html shapes stuff
# the following line is a list that will help generating the string
# using "".join()
- shape_string_list = []
- shape_string_list.append("loader = new THREE.BufferGeometryLoader();\n")
- shape_idx = 0
- for shape_hash in self._3js_shapes:
+ shape_string_list = ["var loader = new THREE.BufferGeometryLoader();\n"]
+ for shape_idx, shape_hash in enumerate(self._3js_shapes):
# get properties for this shape
- export_edges, color, specular_color, shininess, transparency, line_color, line_width = self._3js_shapes[shape_hash]
- # creates a material for the shape
- shape_string_list.append('\t\t\t%s_phong_material = new THREE.MeshPhongMaterial({' % shape_hash)
- shape_string_list.append('color:%s,' % color_to_hex(color))
- shape_string_list.append('specular:%s,' % color_to_hex(specular_color))
- shape_string_list.append('shininess:%g,' % shininess)
- # force double side rendering, see issue #645
- shape_string_list.append('side: THREE.DoubleSide,')
- if transparency > 0.:
- shape_string_list.append('transparent: true, premultipliedAlpha: true, opacity:%g,' % transparency)
- #var line_material = new THREE.LineBasicMaterial({color: 0x000000, linewidth: 2});
- shape_string_list.append('});\n')
- # load json geometry files
- shape_string_list.append("\t\t\tloader.load('%s.json', function(geometry) {\n" % shape_hash)
- shape_string_list.append("\t\t\t\tmesh = new THREE.Mesh(geometry, %s_phong_material);\n" % shape_hash)
- # enable shadows for object
- shape_string_list.append("\t\t\t\tmesh.castShadow = true;\n")
- shape_string_list.append("\t\t\t\tmesh.receiveShadow = true;\n")
- # add mesh to scene
- shape_string_list.append("\t\t\t\tscene.add(mesh);\n")
+ (
+ export_edges,
+ color,
+ specular_color,
+ shininess,
+ transparency,
+ line_color,
+ line_width,
+ ) = self._3js_shapes[shape_hash]
+ shape_string_list.extend(
+ (
+ "\t\t\tvar %s_phong_material = new THREE.MeshPhongMaterial({"
+ % shape_hash,
+ f"color:{color_to_hex(color)},",
+ f"specular:{color_to_hex(specular_color)},",
+ "shininess:%g," % shininess,
+ "side: THREE.DoubleSide,",
+ "flatShading:false,",
+ )
+ )
+ if transparency > 0.0:
+ shape_string_list.append(
+ "transparent: true, premultipliedAlpha: true, opacity:%g,"
+ % transparency
+ )
+ shape_string_list.extend(
+ (
+ "});\n",
+ "\t\t\tloader.load('%s.json', function(geometry) {\n" % shape_hash,
+ "\t\t\t\tvar mesh = new THREE.Mesh(geometry, %s_phong_material);\n"
+ % shape_hash,
+ "\t\t\t\tmesh.castShadow = true;\n",
+ "\t\t\t\tmesh.receiveShadow = true;\n",
+ "\t\t\t\tscene.add(mesh);\n",
+ )
+ )
# last shape, we request for a fit_to_scene
if shape_idx == len(self._3js_shapes) - 1:
shape_string_list.append("\tfit_to_scene();});\n")
else:
shape_string_list.append("\t\t\t});\n\n")
- shape_idx += 1
# Process edges
edge_string_list = []
for edge_hash in self._3js_edges:
color, line_width = self._3js_edges[edge_hash]
- edge_string_list.append("\tloader.load('%s.json', function(geometry) {\n" % edge_hash)
- edge_string_list.append("\tline_material = new THREE.LineBasicMaterial({color: %s, linewidth: %s});\n" % ((color_to_hex(color), line_width)))
- edge_string_list.append("\tline = new THREE.Line(geometry, line_material);\n")
- # add mesh to scene
- edge_string_list.append("\tscene.add(line);\n")
- edge_string_list.append("\t});\n")
- # write the string for the shape
+ edge_string_list.extend(
+ (
+ "\tloader.load('%s.json', function(geometry) {\n" % edge_hash,
+ "\tvar line_material = new THREE.LineBasicMaterial({color: %s, linewidth: %s});\n"
+ % ((color_to_hex(color), line_width)),
+ "\tvar line = new THREE.Line(geometry, line_material);\n",
+ "\tscene.add(line);\n",
+ "\t});\n",
+ )
+ )
+ # write the main.js file
+ with open(self._main_js_filename, "w") as fp:
+ main_js = MAIN_JS_TEMPLATE.substitute(
+ {
+ "ShapeList": "".join(shape_string_list),
+ "EdgeList": "".join(edge_string_list),
+ "Uniforms": "",
+ "ShaderMaterialDefinition": "",
+ }
+ )
+ fp.write(main_js)
+
+ # write the index.html file
with open(self._html_filename, "w") as fp:
fp.write("\n")
fp.write("")
# header
fp.write(HTMLHeader().get_str())
# body
- BODY_PART0 = BODY_PART0.replace('@VERSION@', OCC_VERSION)
- fp.write(BODY_PART0)
- fp.write(HTMLBody_Part1().get_str())
- fp.write("".join(shape_string_list))
- fp.write("".join(edge_string_list))
- # then write header part 2
- fp.write(BODY_PART2)
+ body = BODY_TEMPLATE.substitute(
+ {
+ "VERSION": VERSION,
+ "VertexShaderDefinition": "",
+ "FragmentShaderDefinition": "",
+ }
+ ) # = BODY_TEMPLATE_PART0.replace("@VERSION@", VERSION)
+ fp.write(body)
fp.write("\n")
- def render(self, addr="localhost", server_port=8080, open_webbrowser=False):
- ''' render the scene into the browser.
- '''
+ def render(
+ self,
+ addr: str = "localhost",
+ server_port: int = 8080,
+ open_webbrowser: bool = False,
+ ) -> None:
+ """
+ Renders the scene in the browser.
+
+ Args:
+ addr (str, optional): The address to bind the server to.
+ server_port (int, optional): The port to use for the server.
+ open_webbrowser (bool, optional): Whether to open a web browser.
+ """
# generate HTML file
self.generate_html_file()
# then create a simple web server
start_server(addr, server_port, self._path, open_webbrowser)
+
if __name__ == "__main__":
from OCC.Core.BRepPrimAPI import BRepPrimAPI_MakeBox, BRepPrimAPI_MakeTorus
from OCC.Core.BRepBuilderAPI import BRepBuilderAPI_Transform
- from OCC.Core.gp import gp_Trsf
+ from OCC.Core.gp import gp_Trsf, gp_Vec
+ from OCC.Core.TopoDS import TopoDS_Shape
import time
- def translate_shp(shp, vec, copy=False):
+
+ def translate_shp(
+ shp: TopoDS_Shape, vec: gp_Vec, copy: bool = False
+ ) -> TopoDS_Shape:
trns = gp_Trsf()
trns.SetTranslation(vec)
brep_trns = BRepBuilderAPI_Transform(shp, trns, copy)
brep_trns.Build()
return brep_trns.Shape()
- box = BRepPrimAPI_MakeBox(100., 200., 300.).Shape()
- torus = BRepPrimAPI_MakeTorus(300., 105).Shape()
+
+ box = BRepPrimAPI_MakeBox(100.0, 200.0, 300.0).Shape()
+ torus = BRepPrimAPI_MakeTorus(300.0, 105).Shape()
t_torus = translate_shp(torus, gp_Vec(700, 0, 0))
my_ren = ThreejsRenderer()
init_time = time.time()
diff --git a/src/Display/WebGl/threejs_renderer.pyi b/src/Display/WebGl/threejs_renderer.pyi
new file mode 100644
index 000000000..16b2d4ad4
--- /dev/null
+++ b/src/Display/WebGl/threejs_renderer.pyi
@@ -0,0 +1,33 @@
+from typing import Any, Dict, Generator, List, Optional, Tuple
+
+def spinning_cursor() -> Generator[str, None, None]: ...
+def color_to_hex(rgb_color: Tuple[float, float, float]) -> str: ...
+def export_edgedata_to_json(edge_hash: str, point_set: List[List[float]]) -> str: ...
+
+class HTMLHeader:
+ def __init__(
+ self, bg_gradient_color1: str = "#ced7de", bg_gradient_color2: str = "#808080"
+ ) -> None: ...
+ def get_str(self) -> str: ...
+
+class ThreejsRenderer:
+ def __init__(self, path: Optional[str] = None) -> None: ...
+ def DisplayShape(
+ self,
+ shape: Any,
+ export_edges: bool = False,
+ color: Tuple[float, float, float] = ...,
+ specular_color: Tuple[float, float, float] = ...,
+ shininess: float = 0.9,
+ transparency: float = 0.0,
+ line_color: Tuple[float, float, float] = ...,
+ line_width: float = 1.0,
+ mesh_quality: float = 1.0,
+ ) -> Tuple[Dict[str, Any], Dict[str, Any]]: ...
+ def generate_html_file(self) -> None: ...
+ def render(
+ self,
+ addr: str = "localhost",
+ server_port: int = 8080,
+ open_webbrowser: bool = False,
+ ) -> None: ...
diff --git a/src/Display/WebGl/x3dom_renderer.py b/src/Display/WebGl/x3dom_renderer.py
index 2bb74386f..09d0e9199 100644
--- a/src/Display/WebGl/x3dom_renderer.py
+++ b/src/Display/WebGl/x3dom_renderer.py
@@ -17,36 +17,45 @@
import os
import sys
+from string import Template
import tempfile
import uuid
+from typing import Any, Dict, Generator, List, Optional, Tuple
from xml.etree import ElementTree
from OCC.Core.Tesselator import ShapeTesselator
-from OCC import VERSION as OCC_VERSION
+from OCC import VERSION
from OCC.Extend.TopologyUtils import is_edge, is_wire, discretize_edge, discretize_wire
from OCC.Display.WebGl.simple_server import start_server
-def spinning_cursor():
+
+def spinning_cursor() -> Generator[str, None, None]:
+ """
+ A spinning cursor generator.
+ """
while True:
- for cursor in '|/-\\':
- yield cursor
+ yield from "|/-\\"
+
-X3DFILE_HEADER = """
+X3DFILE_HEADER_TEMPLATE = Template(
+ """
@@ -140,291 +167,326 @@ def export_edgedata_to_json(edge_hash, point_set): g view/hide grid
a view/hide axis
- pythonocc-@VERSION@ x3dom renderer
-
Check our blog at - http://www.pythonocc.org + pythonocc-$VERSION x3dom renderer
Check our blog at - http://www.pythonocc.org + pythonocc-$VERSION x3dom renderer
t view/hide shape
@@ -139,7 +148,7 @@ def spinning_cursor(): current_mat = mat; console.log(mat); selected_target_color = mat.diffuseColor; - mat.diffuseColor = "1, 0.65, 0"; + mat.diffuseColor = "1. 0.65 0."; //console.log(the_shape.getElementsByTagName("Appearance"));//.getAttribute('diffuseColor')); } function onDocumentKeyPress(event) { @@ -148,9 +157,11 @@ def spinning_cursor(): if (current_selected_shape) { if (current_selected_shape.render == "true") { current_selected_shape.render = "false"; + console.log("hide ", current_selected_shape); } else { current_selected_shape.render = "true"; + console.log("show ", current_selected_shape) } } } @@ -161,112 +172,189 @@ def spinning_cursor(): """ +) + + +def export_edge_to_indexed_lineset(edge_point_set: List[List[float]]) -> str: + """ + Exports an edge to an IndexedLineSet string. + Args: + edge_point_set (list): A list of points. -def export_edge_to_indexed_lineset(edge_point_set): - str_x3d_to_return = "\t" % len(edge_point_set)
+ Returns:
+ str: The IndexedLineSet string.
+ """
+ str_x3d_to_return = f"\t"
str_x3d_to_return += " \n"
return str_x3d_to_return
-def indexed_lineset_to_x3d_string(str_linesets, header=True, footer=True, ils_id=0):
- """ takes an str_lineset, coming for instance from export_curve_to_ils,
- and export to an X3D string"""
- if header:
- x3dfile_str = X3DFILE_HEADER
- else:
- x3dfile_str = ""
+def indexed_lineset_to_x3d_string(
+ str_linesets: List[str], header: bool = True, footer: bool = True, ils_id: int = 0
+) -> str:
+ """
+ Converts an IndexedLineSet string to an X3D string.
+
+ Args:
+ str_linesets (list): A list of IndexedLineSet strings.
+ header (bool, optional): Whether to include the X3D header.
+ footer (bool, optional): Whether to include the X3D footer.
+ ils_id (int, optional): The ID of the IndexedLineSet.
+
+ Returns:
+ str: The X3D string.
+ """
+ x3dfile_str = (
+ X3DFILE_HEADER_TEMPLATE.substitute({"VERSION": f"{VERSION}"}) if header else ""
+ )
x3dfile_str += "\n"
x3dfile_str += "\t\n"
- ils_id = 0
- for str_lineset in str_linesets:
- x3dfile_str += "\t\t\n" % ils_id
+ for ils_id, str_lineset in enumerate(str_linesets):
+ x3dfile_str += f"\t\t\n"
# empty appearance, but the x3d validator complains if nothing set
- x3dfile_str += "\t\t\t \n"
x3dfile_str += " \n"
if footer:
- x3dfile_str += '\n\n'
+ x3dfile_str += "\n\n"
return x3dfile_str
class HTMLHeader:
- def __init__(self, bg_gradient_color1="#ced7de", bg_gradient_color2="#808080"):
+ """
+ A class to generate the HTML header.
+ """
+
+ def __init__(
+ self, bg_gradient_color1: str = "#ced7de", bg_gradient_color2: str = "#808080"
+ ) -> None:
+ """
+ Initializes the HTMLHeader.
+
+ Args:
+ bg_gradient_color1 (str, optional): The first color of the background gradient.
+ bg_gradient_color2 (str, optional): The second color of the background gradient.
+ """
self._bg_gradient_color1 = bg_gradient_color1
self._bg_gradient_color2 = bg_gradient_color2
-
- def get_str(self):
- header_str = HEADER.replace('@bg_gradient_color1@', '%s' % self._bg_gradient_color1)
- header_str = header_str.replace('@bg_gradient_color2@', '%s' % self._bg_gradient_color2)
- header_str = header_str.replace('@VERSION@', OCC_VERSION)
- return header_str
+ def get_str(self) -> str:
+ """
+ Returns the HTML header as a string.
+ """
+ return HEADER_TEMPLATE.substitute(
+ {
+ "bg_gradient_color1": f"{self._bg_gradient_color1}",
+ "bg_gradient_color2": f"{self._bg_gradient_color2}",
+ "VERSION": f"{VERSION}",
+ }
+ )
class HTMLBody:
- def __init__(self, x3d_shapes, axes_plane, axes_plane_zoom_factor=1.):
- """ x3d_shapes is a list that contains uid for each shape
+ """
+ A class to generate the HTML body.
+ """
+
+ def __init__(
+ self,
+ x3d_shapes: List[str],
+ axes_plane: bool,
+ axes_plane_zoom_factor: float = 1.0,
+ ) -> None:
+ """
+ Initializes the HTMLBody.
+
+ Args:
+ x3d_shapes (list): A list of shape UIDs.
+ axes_plane (bool): Whether to display the axes plane.
+ axes_plane_zoom_factor (float, optional): The zoom factor for the axes plane.
"""
self._x3d_shapes = x3d_shapes
self.spinning_cursor = spinning_cursor()
self._display_axes_plane = axes_plane
self._axis_plane_zoom_factor = axes_plane_zoom_factor
- def get_str(self):
+ def get_str(self) -> str:
+ """
+ Returns the HTML body as a string.
+ """
# get the location where pythonocc is running from
- body_str = BODY.replace('@VERSION@', OCC_VERSION)
- x3dcontent = '\n\t\n\t\t\n'
+ x3dcontent = "\n\t\n\t\t\n"
nb_shape = len(self._x3d_shapes)
- cur_shp = 1
if self._display_axes_plane:
- x3dcontent += """
-
-
+ x3dcontent += f"""
+
+
- """ % (self._axis_plane_zoom_factor, self._axis_plane_zoom_factor, self._axis_plane_zoom_factor)
- # global rotateso that z is aligne properly
- x3dcontent += ''
- for shp_uid in self._x3d_shapes:
- sys.stdout.write("\r%s meshing shapes... %i%%" % (next(self.spinning_cursor),
- round(cur_shp / nb_shape * 100)))
+ """
+ # global rotate so that z is properly aligned
+ x3dcontent += '\n'
+ for cur_shp, shp_uid in enumerate(self._x3d_shapes, start=1):
+ sys.stdout.write(
+ "\r%s meshing shapes... %i%%"
+ % (next(self.spinning_cursor), round(cur_shp / nb_shape * 100))
+ )
sys.stdout.flush()
+ # only the last downloaded shape raises a fitCamera event
+ x3dcontent += "\t\t\t \n\t\t \n\t \n"
- x3dcontent += '\t\t\t \n\t \n"
- body_str = body_str.replace('@X3DSCENE@', x3dcontent)
- return body_str
+ return BODY_TEMPLATE.substitute(
+ {"VERSION": f"{VERSION}", "X3DSCENE": f"{x3dcontent}"}
+ )
class X3DExporter:
- """ A class for exporting a TopoDS_Shape to an x3d file """
- def __init__(self,
- shape, # the TopoDS shape to mesh
- vertex_shader, # the vertex_shader, passed as a string
- fragment_shader, # the fragment shader, passed as a string
- export_edges, # if yes, edges are exported to IndexedLineSet (might be SLOWW)
- color, # the default shape color
- specular_color, # shape specular color (white by default)
- shininess, # shape shininess
- transparency, # shape transparency
- line_color, # edge color
- line_width, # edge liewidth,
- mesh_quality # mesh quality default is 1., good is <1, bad is >1
- ):
+ """A class for exporting a TopoDS_Shape to an x3d file"""
+
+ def __init__(
+ self,
+ shape: Any,
+ vertex_shader: Optional[str],
+ fragment_shader: Optional[str],
+ export_edges: bool,
+ color: Tuple[float, float, float],
+ specular_color: Tuple[float, float, float],
+ shininess: float,
+ transparency: float,
+ line_color: Tuple[float, float, float],
+ line_width: float,
+ mesh_quality: float,
+ ) -> None:
+ """
+ Initializes the X3DExporter.
+
+ Args:
+ shape: The shape to export.
+ vertex_shader: The vertex shader to use.
+ fragment_shader: The fragment shader to use.
+ export_edges: Whether to export edges.
+ color: The color of the shape.
+ specular_color: The specular color of the shape.
+ shininess: The shininess of the shape.
+ transparency: The transparency of the shape.
+ line_color: The color of the lines.
+ line_width: The width of the lines.
+ mesh_quality: The quality of the mesh.
+ """
self._shape = shape
self._vs = vertex_shader
self._fs = fragment_shader
@@ -279,54 +367,72 @@ def __init__(self,
# the list of indexed face sets that compose the shape
# if ever the map_faces_to_mesh option is enabled, this list
# maybe composed of dozains of TriangleSet
- self._triangle_sets = []
- self._line_sets = []
+ self._triangle_sets: List[str] = []
+ self._line_sets: List[str] = []
self._x3d_string = "" # the string that contains the x3d description
- def compute(self):
+ def compute(self) -> None:
+ """
+ Computes the tessellation of the shape.
+ """
shape_tesselator = ShapeTesselator(self._shape)
- shape_tesselator.Compute(compute_edges=self._export_edges,
- mesh_quality=self._mesh_quality,
- parallel=True)
+
+ if shape_tesselator.GetDeviation() <= 0:
+ raise ValueError("The deviation is <= 0.")
+
+ shape_tesselator.Compute(
+ compute_edges=self._export_edges,
+ mesh_quality=self._mesh_quality,
+ parallel=True,
+ )
self._triangle_sets.append(shape_tesselator.ExportShapeToX3DTriangleSet())
# then process edges
if self._export_edges:
# get number of edges
nbr_edges = shape_tesselator.ObjGetEdgeCount()
for i_edge in range(nbr_edges):
- edge_point_set = []
nbr_vertices = shape_tesselator.ObjEdgeGetVertexCount(i_edge)
- for i_vert in range(nbr_vertices):
- edge_point_set.append(shape_tesselator.GetEdgeVertex(i_edge, i_vert))
+ edge_point_set = [
+ shape_tesselator.GetEdgeVertex(i_edge, i_vert)
+ for i_vert in range(nbr_vertices)
+ ]
ils = export_edge_to_indexed_lineset(edge_point_set)
self._line_sets.append(ils)
- def to_x3dfile_string(self, shape_id):
- x3dfile_str = X3DFILE_HEADER
+ def to_x3dfile_string(self, shape_id: int) -> str:
+ """
+ Converts the shape to an X3D string.
+
+ Args:
+ shape_id (int): The ID of the shape.
+
+ Returns:
+ str: The X3D string.
+ """
+ x3dfile_str = X3DFILE_HEADER_TEMPLATE.substitute({"VERSION": f"{VERSION}"})
for triangle_set in self._triangle_sets:
- x3dfile_str += "\n"
+ x3dfile_str += ""
+ x3dfile_str += f"\n\n"
+ x3dfile_str += "\n"
#
# set Material or shader
#
if self._vs is None and self._fs is None:
- x3dfile_str += "\n"
else: # set shaders
- x3dfile_str += '\n"
x3dfile_str += ' \n'
- x3dfile_str += ' \n'
+ x3dfile_str += "\n"
+ x3dfile_str += " \n"
# export triangles
x3dfile_str += triangle_set
x3dfile_str += "
@@ -139,7 +148,7 @@ def spinning_cursor(): current_mat = mat; console.log(mat); selected_target_color = mat.diffuseColor; - mat.diffuseColor = "1, 0.65, 0"; + mat.diffuseColor = "1. 0.65 0."; //console.log(the_shape.getElementsByTagName("Appearance"));//.getAttribute('diffuseColor')); } function onDocumentKeyPress(event) { @@ -148,9 +157,11 @@ def spinning_cursor(): if (current_selected_shape) { if (current_selected_shape.render == "true") { current_selected_shape.render = "false"; + console.log("hide ", current_selected_shape); } else { current_selected_shape.render = "true"; + console.log("show ", current_selected_shape) } } } @@ -161,112 +172,189 @@ def spinning_cursor(): """ +) + + +def export_edge_to_indexed_lineset(edge_point_set: List[List[float]]) -> str: + """ + Exports an edge to an IndexedLineSet string. + Args: + edge_point_set (list): A list of points. -def export_edge_to_indexed_lineset(edge_point_set): - str_x3d_to_return = "\t