Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Gizmos/GLGizmosCommon.hpp>

Inheritance diagram for Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper:

Collaboration diagram for Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper:

Public Member Functions
	ObjectClipper (CommonGizmosDataPool *cgdp)
CommonGizmosDataID	get_dependencies () const override
double	get_position () const
void	set_position_to_init_layer ()
const ClippingPlane *	get_clipping_plane (bool ignore_hide_clipped=false) const
void	render_cut (const std::vector< size_t > *ignore_idxs=nullptr) const
void	set_position_by_ratio (double pos, const Vec3d &normal)
void	set_range_and_pos (const Vec3d &cpl_normal, double cpl_offset, double pos)
void	set_behavior (bool hide_clipped, bool fill_cut, double contour_width)
int	get_number_of_contours () const
std::vector< Vec3d >	point_per_contour () const
int	is_projection_inside_cut (const Vec3d &point_in) const
bool	has_valid_contour () const
void	update ()
void	release ()
bool	is_valid () const

Protected Member Functions
void	on_update () override
void	on_release () override
CommonGizmosDataPool *	get_pool () const

Private Attributes
std::vector< const TriangleMesh * >	m_old_meshes
std::vector< std::pair< std::unique_ptr< MeshClipper >, Geometry::Transformation > >	m_clippers
std::unique_ptr< ClippingPlane >	m_clp
double	m_clp_ratio = 0.
double	m_active_inst_bb_radius = 0.
bool	m_hide_clipped = true
bool	m_is_valid = false
CommonGizmosDataPool *	m_common = nullptr

Detailed Description

Constructor & Destructor Documentation

ObjectClipper()

Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::ObjectClipper ( CommonGizmosDataPool * cgdp )

inlineexplicit

        : CommonGizmosDataBase(cgdp) {}

References Slic3r::GUI::CommonGizmosDataBase::CommonGizmosDataBase().

Here is the call graph for this function:

Member Function Documentation

get_clipping_plane()

const ClippingPlane * Slic3r::GUI::ObjectClipper::get_clipping_plane

(

bool

ignore_hide_clipped = false

)

const

{
    static const ClippingPlane no_clip = ClippingPlane::ClipsNothing();
    return (ignore_hide_clipped || m_hide_clipped) ? m_clp.get() : &no_clip;
}

References Slic3r::GUI::ClippingPlane::ClipsNothing(), m_clp, and m_hide_clipped.

Referenced by Slic3r::GUI::CommonGizmosDataObjects::InstancesHider::render_cut().

Here is the call graph for this function:

Here is the caller graph for this function:

get_dependencies()

CommonGizmosDataID Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::get_dependencies ( ) const

inlineoverridevirtual

Reimplemented from Slic3r::GUI::CommonGizmosDataBase.

{ return CommonGizmosDataID::SelectionInfo; }

References Slic3r::GUI::SelectionInfo.

get_number_of_contours()

int Slic3r::GUI::ObjectClipper::get_number_of_contours

(

)

const

{
    int sum = 0;
    for (const auto& [clipper, trafo] : m_clippers)
        sum += clipper->get_number_of_contours();
    return sum;
}

References m_clippers.

get_pool()

CommonGizmosDataPool * Slic3r::GUI::CommonGizmosDataBase::get_pool ( ) const

inlineprotectedinherited

{ return m_common; }

References m_common.

Referenced by Slic3r::GUI::CommonGizmosDataObjects::SelectionInfo::get_active_instance(), Slic3r::GUI::CommonGizmosDataObjects::InstancesHider::on_release(), Slic3r::GUI::CommonGizmosDataObjects::InstancesHider::on_update(), Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::on_update(), Slic3r::GUI::CommonGizmosDataObjects::Raycaster::on_update(), Slic3r::GUI::CommonGizmosDataObjects::SelectionInfo::on_update(), Slic3r::GUI::CommonGizmosDataObjects::InstancesHider::render_cut(), Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::render_cut(), Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::set_position_by_ratio(), Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::set_position_to_init_layer(), and Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::set_range_and_pos().

Here is the caller graph for this function:

get_position()

double Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::get_position ( ) const

inline

{ return m_clp_ratio; }

References m_clp_ratio.

Referenced by Slic3r::GUI::CommonGizmosDataObjects::InstancesHider::render_cut().

Here is the caller graph for this function:

has_valid_contour()

bool Slic3r::GUI::ObjectClipper::has_valid_contour

(

)

const

{
    return m_clp_ratio != 0. && std::any_of(m_clippers.begin(), m_clippers.end(), [](const auto& cl) { return cl.first->has_valid_contour(); });
}

References m_clippers, and m_clp_ratio.

is_projection_inside_cut()

int Slic3r::GUI::ObjectClipper::is_projection_inside_cut

(

const Vec3d &

point_in

)

const

{
    if (m_clp_ratio == 0.)
        return -1;
    int idx_offset = 0;
    for (const auto& [clipper, trafo] : m_clippers) {
        if (int idx = clipper->is_projection_inside_cut(point); idx != -1)
            return idx_offset + idx;
        idx_offset += clipper->get_number_of_contours();
    }
    return -1;
}

References m_clippers, and m_clp_ratio.

is_valid()

bool Slic3r::GUI::CommonGizmosDataBase::is_valid ( ) const

inlineinherited

{ return m_is_valid; }

References m_is_valid.

Referenced by Slic3r::GUI::CommonGizmosDataPool::instances_hider(), Slic3r::GUI::CommonGizmosDataPool::object_clipper(), Slic3r::GUI::CommonGizmosDataPool::raycaster(), Slic3r::GUI::CommonGizmosDataObjects::InstancesHider::render_cut(), and Slic3r::GUI::CommonGizmosDataPool::selection_info().

Here is the caller graph for this function:

on_release()

void Slic3r::GUI::ObjectClipper::on_release ( )

overrideprotectedvirtual

Implements Slic3r::GUI::CommonGizmosDataBase.

{
    m_clippers.clear();
    m_old_meshes.clear();
    m_clp.reset();
    m_clp_ratio = 0.;
 
}

References m_clippers, m_clp, m_clp_ratio, and m_old_meshes.

on_update()

void Slic3r::GUI::ObjectClipper::on_update ( )

overrideprotectedvirtual

Implements Slic3r::GUI::CommonGizmosDataBase.

{
    const ModelObject* mo = get_pool()->selection_info()->model_object();
    if (! mo)
        return;
 
    // which mesh should be cut?
    std::vector<const TriangleMesh*> meshes;
    std::vector<Geometry::Transformation> trafos;
    for (const ModelVolume* mv : mo->volumes) {
        meshes.emplace_back(&mv->mesh());
        trafos.emplace_back(mv->get_transformation());
    }
 
    if (meshes != m_old_meshes) {
        m_clippers.clear();
        for (size_t i = 0; i < meshes.size(); ++i) {
            m_clippers.emplace_back(new MeshClipper, trafos[i]);
            m_clippers.back().first->set_mesh(meshes[i]->its);
        }
        m_old_meshes = std::move(meshes);
 
        m_active_inst_bb_radius =
            mo->instance_bounding_box(get_pool()->selection_info()->get_active_instance()).radius();
    }
}

References Slic3r::GUI::CommonGizmosDataBase::get_pool(), Slic3r::ModelVolume::get_transformation(), Slic3r::ModelObject::instance_bounding_box(), m_active_inst_bb_radius, m_clippers, m_old_meshes, Slic3r::ModelVolume::mesh(), Slic3r::GUI::CommonGizmosDataObjects::SelectionInfo::model_object(), Slic3r::BoundingBox3Base< PointType >::radius(), Slic3r::GUI::CommonGizmosDataPool::selection_info(), and Slic3r::ModelObject::volumes.

Here is the call graph for this function:

point_per_contour()

std::vector< Vec3d > Slic3r::GUI::ObjectClipper::point_per_contour

(

)

const

{
    std::vector<Vec3d> pts;
 
    for (const auto& clipper : m_clippers) {
        const std::vector<Vec3d> pts_clipper = clipper.first->point_per_contour();
        pts.insert(pts.end(), pts_clipper.begin(), pts_clipper.end());;
    }
    return pts;
}

References m_clippers.

Referenced by Slic3r::GUI::GLGizmoCut3D::PartSelection::PartSelection().

Here is the caller graph for this function:

release()

void Slic3r::GUI::CommonGizmosDataBase::release ( )

inlineinherited

{ on_release(); m_is_valid = false; }

References m_is_valid, and on_release().

Here is the call graph for this function:

render_cut()

void Slic3r::GUI::ObjectClipper::render_cut

(

const std::vector< size_t > *

ignore_idxs = nullptr

)

const

{
    if (m_clp_ratio == 0.)
        return;
    const SelectionInfo* sel_info = get_pool()->selection_info();
    const Geometry::Transformation inst_trafo = sel_info->model_object()->instances[sel_info->get_active_instance()]->get_transformation();
    
    std::vector<size_t> ignore_idxs_local = ignore_idxs ? *ignore_idxs : std::vector<size_t>();
 
    for (auto& clipper : m_clippers) {
        Geometry::Transformation trafo = inst_trafo * clipper.second;
        trafo.set_offset(trafo.get_offset() + Vec3d(0., 0., sel_info->get_sla_shift()));
        clipper.first->set_plane(*m_clp);
        clipper.first->set_transformation(trafo);
        clipper.first->set_limiting_plane(ClippingPlane(Vec3d::UnitZ(), -SINKING_Z_THRESHOLD));
    // BBS      
        clipper.first->render_cut({ 0.25f, 0.25f, 0.25f, 1.0f }, &ignore_idxs_local);
        clipper.first->render_contour({ 1.f, 1.f, 1.f, 1.f },  &ignore_idxs_local);
  
        // Now update the ignore idxs. Find the first element belonging to the next clipper,
        // and remove everything before it and decrement everything by current number of contours.
        const int num_of_contours = clipper.first->get_number_of_contours();
        ignore_idxs_local.erase(ignore_idxs_local.begin(), std::find_if(ignore_idxs_local.begin(), ignore_idxs_local.end(), [num_of_contours](size_t idx) { return idx >= size_t(num_of_contours); } ));
        for (size_t& idx : ignore_idxs_local)
            idx -= num_of_contours;
    }
}

References Slic3r::GUI::CommonGizmosDataObjects::SelectionInfo::get_active_instance(), Slic3r::Geometry::Transformation::get_offset(), Slic3r::GUI::CommonGizmosDataBase::get_pool(), Slic3r::GUI::CommonGizmosDataObjects::SelectionInfo::get_sla_shift(), Slic3r::ModelObject::instances, m_clippers, m_clp, m_clp_ratio, Slic3r::GUI::CommonGizmosDataObjects::SelectionInfo::model_object(), Slic3r::GUI::CommonGizmosDataPool::selection_info(), Slic3r::Geometry::Transformation::set_offset(), and Slic3r::SINKING_Z_THRESHOLD.

Here is the call graph for this function:

set_behavior()

void Slic3r::GUI::ObjectClipper::set_behavior	(	bool	hide_clipped,
		bool	fill_cut,
		double	contour_width )

{
    m_hide_clipped = hide_clipped;
    for (auto& clipper : m_clippers)
        clipper.first->set_behaviour(fill_cut, contour_width);
}

References m_clippers, and m_hide_clipped.

set_position_by_ratio()

void Slic3r::GUI::ObjectClipper::set_position_by_ratio	(	double	pos,
		const Vec3d &	normal )

{
    const ModelObject* mo = get_pool()->selection_info()->model_object();
    int active_inst = get_pool()->selection_info()->get_active_instance();
    double z_shift = get_pool()->selection_info()->get_sla_shift();
    if (pos == 0. || mo == nullptr || active_inst < 0) {
        // No plane, so the raycasts are not clipped.
        m_clp_ratio = 0.;
        m_clp.reset();
        get_pool()->get_canvas()->set_as_dirty();
        return;
    }
 
    Vec3d center;
 
    if (get_pool()->get_canvas()->get_canvas_type() == GLCanvas3D::CanvasAssembleView) {
        const SelectionInfo* sel_info = get_pool()->selection_info();
        auto trafo = mo->instances[sel_info->get_active_instance()]->get_assemble_transformation();
        auto offset_to_assembly = mo->instances[0]->get_offset_to_assembly();
        center = trafo.get_offset() + offset_to_assembly * (GLVolume::explosion_ratio - 1.0);
    }
    else {
        center = mo->instances[active_inst]->get_offset() + Vec3d(0., 0., z_shift);
    }
 
    float dist = normal.dot(center);
 
    m_clp_ratio = pos;
 
    m_clp.reset(new ClippingPlane(normal, (dist - (-m_active_inst_bb_radius) - m_clp_ratio * 2 * m_active_inst_bb_radius)));
 
    get_pool()->get_canvas()->set_as_dirty();
}

References Slic3r::GUI::GLCanvas3D::CanvasAssembleView, Slic3r::center(), Slic3r::Geometry::dist(), Slic3r::GLVolume::explosion_ratio, Slic3r::GUI::CommonGizmosDataObjects::SelectionInfo::get_active_instance(), Slic3r::GUI::CommonGizmosDataPool::get_canvas(), Slic3r::GUI::CommonGizmosDataBase::get_pool(), Slic3r::GUI::CommonGizmosDataObjects::SelectionInfo::get_sla_shift(), Slic3r::ModelObject::instances, m_active_inst_bb_radius, m_clp, m_clp_ratio, Slic3r::GUI::CommonGizmosDataObjects::SelectionInfo::model_object(), Slic3r::normal(), Slic3r::GUI::CommonGizmosDataPool::selection_info(), and Slic3r::GUI::GLCanvas3D::set_as_dirty().

Referenced by Slic3r::GUI::GLGizmosManager::update_section_view().

Here is the call graph for this function:

Here is the caller graph for this function:

set_position_to_init_layer()

void Slic3r::GUI::ObjectClipper::set_position_to_init_layer

(

)

{
    m_clp.reset(new ClippingPlane({0, 0, 1}, 0.1));
    get_pool()->get_canvas()->set_as_dirty();
}

References Slic3r::GUI::CommonGizmosDataPool::get_canvas(), Slic3r::GUI::CommonGizmosDataBase::get_pool(), m_clp, and Slic3r::GUI::GLCanvas3D::set_as_dirty().

Here is the call graph for this function:

set_range_and_pos()

void Slic3r::GUI::ObjectClipper::set_range_and_pos	(	const Vec3d &	cpl_normal,
		double	cpl_offset,
		double	pos )

{
    // Called every frame by GLGizmoCut3D::on_render(), usually with the plane already set.
    if (m_clp && *m_clp == ClippingPlane(cpl_normal, cpl_offset) && m_clp_ratio == pos)
        return;
 
    m_clp.reset(new ClippingPlane(cpl_normal, cpl_offset));
    m_clp_ratio = pos;
    get_pool()->get_canvas()->set_as_dirty();
}

References Slic3r::GUI::CommonGizmosDataPool::get_canvas(), Slic3r::GUI::CommonGizmosDataBase::get_pool(), m_clp, m_clp_ratio, and Slic3r::GUI::GLCanvas3D::set_as_dirty().

Here is the call graph for this function:

update()

void Slic3r::GUI::CommonGizmosDataBase::update ( )

inlineinherited

{ on_update(); m_is_valid = true; }

References m_is_valid, and on_update().

Here is the call graph for this function:

Member Data Documentation

m_active_inst_bb_radius

double Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::m_active_inst_bb_radius = 0.

private

Referenced by on_update(), and set_position_by_ratio().

m_clippers

std::vector<std::pair<std::unique_ptr<MeshClipper>, Geometry::Transformation> > Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::m_clippers

private

Referenced by get_number_of_contours(), has_valid_contour(), is_projection_inside_cut(), on_release(), on_update(), point_per_contour(), render_cut(), and set_behavior().

m_clp

std::unique_ptr<ClippingPlane> Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::m_clp

private

Referenced by get_clipping_plane(), on_release(), render_cut(), set_position_by_ratio(), set_position_to_init_layer(), and set_range_and_pos().

m_clp_ratio

double Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::m_clp_ratio = 0.

private

Referenced by get_position(), has_valid_contour(), is_projection_inside_cut(), on_release(), render_cut(), set_position_by_ratio(), and set_range_and_pos().

m_common

CommonGizmosDataPool* Slic3r::GUI::CommonGizmosDataBase::m_common = nullptr

privateinherited

Referenced by CommonGizmosDataBase(), and get_pool().

m_hide_clipped

bool Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::m_hide_clipped = true

private

Referenced by get_clipping_plane(), and set_behavior().

m_is_valid

bool Slic3r::GUI::CommonGizmosDataBase::m_is_valid = false

privateinherited

Referenced by is_valid(), release(), and update().

m_old_meshes

std::vector<const TriangleMesh*> Slic3r::GUI::CommonGizmosDataObjects::ObjectClipper::m_old_meshes

private

Referenced by on_release(), and on_update().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Gizmos/GLGizmosCommon.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/Gizmos/GLGizmosCommon.cpp