Slic3r::SketchPlane Struct Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/CAD/SketchEngine.hpp>

Public Member Functions
Vec2d	project (const Vec3d &ray_origin, const Vec3d &ray_dir) const
Vec3d	to_world (const Vec2d &pt) const
template<class Archive>
void	serialize (Archive &ar)

Static Public Member Functions
static SketchPlane	from_face (const TopoDS_Face &face)
static SketchPlane	XY ()
static SketchPlane	XZ ()
static SketchPlane	YZ ()

Public Attributes
Vec3d	origin {0,0,0}
Vec3d	normal {0,0,1}
Vec3d	x_axis {1,0,0}
Vec3d	y_axis {0,1,0}

Detailed Description

Member Function Documentation

from_face()

SketchPlane Slic3r::SketchPlane::from_face ( const TopoDS_Face & face )

static

{
    SketchPlane sp;
    // Use the first triangulation vertex + face normal
    TopLoc_Location loc;
    Handle(Poly_Triangulation) tri = BRep_Tool::Triangulation(face, loc);
    if (!tri.IsNull() && tri->NbNodes() > 0) {
        gp_Pnt p = tri->Node(1).Transformed(loc.Transformation());
        sp.origin = Vec3d(p.X(), p.Y(), p.Z());
    }
    // Compute normal from BRep face
    BRepAdaptor_Surface surf(face);
    if (surf.GetType() != GeomAbs_Plane) {
        // Fallback: try to use the first uv point
        double u1 = surf.FirstUParameter(), v1 = surf.FirstVParameter();
        gp_Pnt pt; gp_Vec du, dv;
        surf.D1(u1, v1, pt, du, dv);
        gp_Dir n = gp_Dir(du.Crossed(dv));
        sp.normal = Vec3d(n.X(), n.Y(), n.Z());
        sp.x_axis = Vec3d(du.X(), du.Y(), du.Z()).normalized();
        sp.y_axis = sp.normal.cross(sp.x_axis).normalized();
        return sp;
    }
    // Plane face — use the plane directly
    gp_Pln pln = surf.Plane();
    sp.origin = Vec3d(pln.Location().X(), pln.Location().Y(), pln.Location().Z());
    gp_Dir n = pln.Axis().Direction();
    sp.normal = Vec3d(n.X(), n.Y(), n.Z());
    gp_Dir xd = pln.XAxis().Direction();
    sp.x_axis = Vec3d(xd.X(), xd.Y(), xd.Z());
    sp.y_axis = sp.normal.cross(sp.x_axis).normalized();
    return sp;
}

References normal, origin, x_axis, and y_axis.

Referenced by Slic3r::GUI::DesignPanel::add_imported_sketch(), Slic3r::CadDocument::apply_cut(), Slic3r::CadDocument::apply_feature(), Slic3r::GUI::DesignPanel::open_text_dialog(), and Slic3r::GUI::DesignPanel::update_extrude_gizmo().

Here is the caller graph for this function:

project()

Vec2d Slic3r::SketchPlane::project	(	const Vec3d &	ray_origin,
		const Vec3d &	ray_dir ) const

{
    double denom = ray_dir.dot(normal);
    if (std::abs(denom) < 1e-12)
        return {0, 0}; // ray parallel to plane
    double t = (origin - ray_origin).dot(normal) / denom;
    if (t < 0)
        return {0, 0}; // behind camera
    Vec3d hit = ray_origin + t * ray_dir;
    Vec3d local = hit - origin;
    return {local.dot(x_axis), local.dot(y_axis)};
}

References Slic3r::dot(), normal, origin, x_axis, and y_axis.

Referenced by Slic3r::GUI::DesignSketchTool::drag_helix_handle().

Here is the call graph for this function:

Here is the caller graph for this function:

serialize()

template<class Archive>

void Slic3r::SketchPlane::serialize ( Archive & ar )

inline

{ ar(origin, normal, x_axis, y_axis); }

References normal, origin, x_axis, and y_axis.

to_world()

Vec3d Slic3r::SketchPlane::to_world

(

const Vec2d &

pt

)

const

{
    return origin + x_axis * pt.x() + y_axis * pt.y();
}

References origin, x_axis, and y_axis.

Referenced by Slic3r::CadDocument::apply_feature(), Slic3r::SketchEngine::entities_to_wires(), Slic3r::GUI::planes_back_to_front(), Slic3r::GUI::reference_label_box(), Slic3r::GUI::DesignSketchTool::render_datum_gizmo(), Slic3r::GUI::DesignSketchTool::render_datum_planes(), Slic3r::revolve_axis_of(), Slic3r::SketchProfile::to_occt_wire(), Slic3r::GUI::DesignPanel::update_revolve_gizmo(), and Slic3r::GUI::DesignPanel::zoom_to_feature().

Here is the caller graph for this function:

XY()

SketchPlane Slic3r::SketchPlane::XY ( )

inlinestatic

{ return {}; }

Referenced by Slic3r::GUI::anonymous_namespace{McpControl.cpp}::action_sketch_begin(), Slic3r::CadDocument::add_pattern(), Slic3r::GUI::DesignPanel::build_candidate(), Slic3r::GUI::anonymous_namespace{McpControl.cpp}::plane_from(), Slic3r::GUI::DesignPanel::plane_from_choice(), Slic3r::GUI::plane_from_index(), Slic3r::CadDocument::resolve_datum_axes(), Slic3r::CadDocument::resolve_datum_planes(), and Slic3r::GUI::DesignPanel::update_reference_planes().

Here is the caller graph for this function:

XZ()

SketchPlane Slic3r::SketchPlane::XZ ( )

inlinestatic

{ return {{0,0,0}, {0,1,0}, {1,0,0}, {0,0,1}}; }

Referenced by Slic3r::GUI::anonymous_namespace{McpControl.cpp}::action_sketch_begin(), Slic3r::GUI::anonymous_namespace{McpControl.cpp}::plane_from(), Slic3r::GUI::plane_from_index(), Slic3r::CadDocument::resolve_datum_axes(), Slic3r::CadDocument::resolve_datum_planes(), and Slic3r::GUI::DesignPanel::update_reference_planes().

Here is the caller graph for this function:

YZ()

SketchPlane Slic3r::SketchPlane::YZ ( )

inlinestatic

{ return {{0,0,0}, {1,0,0}, {0,1,0}, {0,0,1}}; }

Referenced by Slic3r::GUI::anonymous_namespace{McpControl.cpp}::action_sketch_begin(), Slic3r::GUI::anonymous_namespace{McpControl.cpp}::plane_from(), Slic3r::GUI::plane_from_index(), Slic3r::CadDocument::resolve_datum_axes(), Slic3r::CadDocument::resolve_datum_planes(), and Slic3r::GUI::DesignPanel::update_reference_planes().

Here is the caller graph for this function:

Member Data Documentation

normal

Vec3d Slic3r::SketchPlane::normal {0,0,1}

{0,0,1};

Referenced by Slic3r::GUI::DesignPanel::DesignPanel(), Slic3r::CadDocument::apply_cut(), Slic3r::CadDocument::apply_feature(), Slic3r::CadDocument::build_sketch_wire(), Slic3r::GUI::DesignSketchTool::drag_helix_handle(), Slic3r::SketchEngine::entities_to_wires(), Slic3r::GUI::face_plane_inward(), Slic3r::frame_from(), from_face(), Slic3r::GUI::index_from_plane(), Slic3r::GUI::is_base_plane(), Slic3r::SketchEngine::make_extrude(), Slic3r::SketchEngine::make_extrude_face(), Slic3r::SketchEngine::make_extrude_regions(), Slic3r::SketchEngine::make_extrude_taper(), Slic3r::SketchEngine::make_extrude_two_sided(), Slic3r::SketchEngine::make_pocket(), Slic3r::offset_angle_plane(), project(), Slic3r::project_edges_to_entities(), Slic3r::GUI::DesignSketchTool::render_cut_gizmo(), Slic3r::GUI::DesignSketchTool::render_draft_gizmo(), Slic3r::GUI::DesignSketchTool::render_extrude_gizmo(), Slic3r::GUI::DesignSketchTool::render_fillet_gizmo(), Slic3r::GUI::DesignSketchTool::render_hole_gizmo(), Slic3r::GUI::DesignSketchTool::render_mate_connectors(), Slic3r::GUI::DesignSketchTool::render_mate_face(), Slic3r::GUI::DesignSketchTool::render_move_gizmo(), Slic3r::GUI::DesignSketchTool::render_pattern_gizmo(), Slic3r::GUI::DesignSketchTool::render_revolve_gizmo(), Slic3r::GUI::DesignSketchTool::render_shell_gizmo(), Slic3r::GUI::DesignSketchTool::render_thread_gizmo(), Slic3r::GUI::DesignSketchTool::render_view_helpers(), Slic3r::CadDocument::resolve_datum_axes(), Slic3r::CadDocument::resolve_datum_planes(), serialize(), Slic3r::GUI::DesignPanel::update_datum_gizmo(), Slic3r::GUI::DesignPanel::update_extrude_gizmo(), Slic3r::GUI::DesignCanvas::view_normal_to_sketch(), and Slic3r::SketchEngine::wires_to_face().

origin

Vec3d Slic3r::SketchPlane::origin {0,0,0}

{0,0,0};

Referenced by Slic3r::GUI::DesignPanel::DesignPanel(), Slic3r::CadDocument::apply_cut(), Slic3r::CadDocument::apply_feature(), Slic3r::CadDocument::build_sketch_wire(), Slic3r::GUI::DesignSketchTool::drag_helix_handle(), Slic3r::GUI::face_plane_inward(), Slic3r::frame_from(), from_face(), Slic3r::GUI::DesignPanel::hole_plane(), Slic3r::GUI::is_base_plane(), Slic3r::SketchEngine::make_extrude_regions(), Slic3r::offset_angle_plane(), Slic3r::GUI::pick_reference_square(), Slic3r::GUI::anonymous_namespace{McpControl.cpp}::plane_from(), Slic3r::GUI::DesignPanel::plane_from_choice(), project(), Slic3r::project_edges_to_entities(), Slic3r::GUI::reference_square(), Slic3r::GUI::DesignSketchTool::render_cut_gizmo(), Slic3r::GUI::DesignSketchTool::render_draft_gizmo(), Slic3r::GUI::DesignSketchTool::render_extrude_gizmo(), Slic3r::GUI::DesignSketchTool::render_fillet_gizmo(), Slic3r::GUI::DesignSketchTool::render_hole_gizmo(), Slic3r::GUI::DesignSketchTool::render_mate_connectors(), Slic3r::GUI::DesignSketchTool::render_mate_face(), Slic3r::GUI::DesignSketchTool::render_move_gizmo(), Slic3r::GUI::DesignSketchTool::render_pattern_gizmo(), Slic3r::GUI::DesignSketchTool::render_revolve_gizmo(), Slic3r::GUI::DesignSketchTool::render_shell_gizmo(), Slic3r::GUI::DesignSketchTool::render_thread_gizmo(), Slic3r::GUI::DesignSketchTool::render_view_helpers(), Slic3r::CadDocument::resolve_datum_axes(), Slic3r::CadDocument::resolve_datum_planes(), Slic3r::revolve_axis_of(), serialize(), Slic3r::GUI::DesignPanel::thread_plane(), to_world(), Slic3r::GUI::DesignPanel::update_datum_gizmo(), Slic3r::GUI::DesignPanel::update_extrude_gizmo(), Slic3r::GUI::DesignPanel::update_pattern_gizmo(), Slic3r::GUI::DesignPanel::update_reference_planes(), Slic3r::GUI::DesignPanel::update_revolve_gizmo(), Slic3r::GUI::DesignCanvas::view_normal_to_sketch(), and Slic3r::SketchEngine::wires_to_face().

x_axis

Vec3d Slic3r::SketchPlane::x_axis {1,0,0}

{1,0,0};

Referenced by Slic3r::GUI::DesignPanel::DesignPanel(), Slic3r::CadDocument::apply_cut(), Slic3r::SketchEngine::entities_to_wires(), Slic3r::GUI::face_plane_inward(), Slic3r::frame_from(), from_face(), Slic3r::GUI::is_base_plane(), Slic3r::offset_angle_plane(), Slic3r::GUI::pick_reference_square(), project(), Slic3r::project_edges_to_entities(), Slic3r::GUI::reference_square(), Slic3r::GUI::DesignSketchTool::render_cut_gizmo(), Slic3r::GUI::DesignSketchTool::render_draft_gizmo(), Slic3r::GUI::DesignSketchTool::render_extrude_gizmo(), Slic3r::GUI::DesignSketchTool::render_fillet_gizmo(), Slic3r::GUI::DesignSketchTool::render_hole_gizmo(), Slic3r::GUI::DesignSketchTool::render_mate_connectors(), Slic3r::GUI::DesignSketchTool::render_mate_face(), Slic3r::GUI::DesignSketchTool::render_move_gizmo(), Slic3r::GUI::DesignSketchTool::render_pattern_gizmo(), Slic3r::GUI::DesignSketchTool::render_revolve_gizmo(), Slic3r::GUI::DesignSketchTool::render_shell_gizmo(), Slic3r::GUI::DesignSketchTool::render_thread_gizmo(), Slic3r::GUI::DesignSketchTool::render_view_helpers(), Slic3r::revolve_axis_of(), serialize(), to_world(), and Slic3r::GUI::DesignPanel::update_revolve_gizmo().

y_axis

Vec3d Slic3r::SketchPlane::y_axis {0,1,0}

{0,1,0};

Referenced by Slic3r::GUI::DesignPanel::DesignPanel(), Slic3r::CadDocument::apply_cut(), Slic3r::SketchEngine::entities_to_wires(), Slic3r::GUI::face_plane_inward(), Slic3r::frame_from(), from_face(), Slic3r::GUI::is_base_plane(), Slic3r::offset_angle_plane(), Slic3r::GUI::pick_reference_square(), project(), Slic3r::project_edges_to_entities(), Slic3r::GUI::reference_square(), Slic3r::GUI::DesignSketchTool::render_cut_gizmo(), Slic3r::GUI::DesignSketchTool::render_draft_gizmo(), Slic3r::GUI::DesignSketchTool::render_extrude_gizmo(), Slic3r::GUI::DesignSketchTool::render_fillet_gizmo(), Slic3r::GUI::DesignSketchTool::render_hole_gizmo(), Slic3r::GUI::DesignSketchTool::render_mate_connectors(), Slic3r::GUI::DesignSketchTool::render_mate_face(), Slic3r::GUI::DesignSketchTool::render_move_gizmo(), Slic3r::GUI::DesignSketchTool::render_pattern_gizmo(), Slic3r::GUI::DesignSketchTool::render_revolve_gizmo(), Slic3r::GUI::DesignSketchTool::render_shell_gizmo(), Slic3r::GUI::DesignSketchTool::render_thread_gizmo(), Slic3r::GUI::DesignSketchTool::render_view_helpers(), Slic3r::revolve_axis_of(), serialize(), to_world(), Slic3r::GUI::DesignPanel::update_revolve_gizmo(), and Slic3r::GUI::DesignCanvas::view_normal_to_sketch().

---

The documentation for this struct was generated from the following files:

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/CAD/SketchEngine.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/CAD/SketchEngine.cpp