DrillHole.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Design
File: DrillHole
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/StationModel.h>
#if NDEVR_DRILL_HOLE
#include <NDEVR/Deployment.h>
#include <NDEVR/Material.h>
#include <NDEVR/Geometry.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A Model which represents a Drilled hole such as ones created at a mining site.
    **/
    class NDEVR_DESIGN_API DrillHole : public StationModel
    {
    public:
        DrillHole()
            : StationModel()
        {}
        DrillHole(const Model& model, const Vector<3, fltp08>& location)
            : StationModel(model)
        {
            /*if (getModelProperty<String>(Model::e_type) != "drill_hole")
            {
                setModelProperty(Model::e_type, "drill_hole");
                setProperty<String>(DesignObject::e_icon, "borehole");
                setCircular(true);
                setAxesLabelsVisible(false);
            }*/
            setLocation(location);
        }
        DrillHole(const Model& model)
            : StationModel(model)
        {
            if (!hasMetaData("drill_hole"))
            {
                setMetaData("drill_hole", true);
                setCircular(true);
            }
        }
 
 
        Model drillRow() const
        {
            Model model = getParent();
            while (model.isValid())
            {
                if (model.isOfType("drill_pattern_row"))
                    return model;
                model = model.getParent();
            }
            return Model();//return invalid
        }
        Model drillPattern() const
        {
            Model model = getParent();
            while (model.isValid())
            {
                if (model.isOfType("drill_pattern"))
                    return model;
                model = model.getParent();
            }
            return Model();//return invalid
        }
        void addHolePath(const String& deployment_name, const Buffer<Vertex<3, fltp08>>& locations, const Buffer<Time>& times, fltp08 radius)
        {
            
            lib_assert(getChildrenByName(deployment_name).size() == 0, "Unexpected duplicate path name");
            Model hole_data = createChild();
            Deployment deployment(hole_data);
            deployment.addSegments(locations, times);
            deployment.setProperty(DesignObject::e_name, deployment_name);
            if(!IsInvalid(radius))
                deployment.setUseTube(Geometry::ThicknessMode::e_circle, radius);
            else
                deployment.setUseTube(Geometry::ThicknessMode::e_pixel, 1.0);
 
        }
        void addHolePath(const String& deployment_name, const Buffer<Vertex<3, fltp08>>& locations, fltp08 radius)
        {
            lib_assert(getChildrenByName(deployment_name).size() == 0, "Unexpected duplicate path name");
            Model hole_data = createChild();
            Deployment deployment(hole_data);
            deployment.addSegments(locations);
            deployment.setProperty(DesignObject::e_name, deployment_name);
            deployment.setUseTube(Geometry::ThicknessMode::e_pixel, radius);
            
        }
        void addHolePath(const String& deployment_name, const Buffer<fltp08>& depths, fltp08 radius)
        {
            Buffer<Vertex<3, fltp08>> new_data(depths.size());
            Vertex<3, fltp08> collar_location = getLocation();
            for (uint04 i = 0; i < depths.size(); i++)
            {
                new_data.add(Vertex<3, fltp08>(collar_location[X], collar_location[Y], depths[i]));
            }
            addHolePath(deployment_name, new_data, radius);
        }
        void setPathVisible(const String& deployment_name, bool visible)
        {
            Buffer<Model> children = getChildrenByName(deployment_name);
            lib_assert(children.size() == 1, "Bad deployment name");
            if (children.size() != 1)
                return;
            children[0].setDesignVisible(visible);
        }
 
        void colorBy(const String& property, fltp08 min, fltp08 mid, fltp08 max)
        {
            Material mat = getMaterial(PrimitiveProperty::Solid);
            mat.setUVMode(UVType::e_KD, Material::UVMode::e_scaled_channel);
            mat.setMaterialProperty(Material::e_extra_property_value_max, min);
            mat.setMaterialProperty(Material::e_extra_property_value_mid, mid);
            mat.setMaterialProperty(Material::e_extra_property_value_min, max);
            mat.setMaterialProperty(Material::e_draw_by_property_channel, property);
            mat.setProperty(DesignProperty::e_modified_time, Time::SystemTime());
        }
        void colorBy(const String& property)
        {
            Material mat = getMaterial(PrimitiveProperty::Solid);
            colorByChannel(mat, property);
        }
    };
}
#endif