Render3D.hpp

Go to the documentation of this file.

/*
# Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#  * Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#  * Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#  * Neither the name of NVIDIA CORPORATION nor the names of its
#    contributors may be used to endorse or promote products derived
#    from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef NVXIO_RENDER3D_HPP
#define NVXIO_RENDER3D_HPP

#include <string>
#include <vector>

#include <VX/vx.h>
#include <NVXIO/Export.hpp>
#include <NVXIO/Render.hpp>

namespace nvxio {

class NVXIO_EXPORT Render3D
{
public:

    enum TargetType
    {
        UNKNOWN_RENDER, 
        BASE_RENDER_3D 
    };

    struct PlaneStyle
    {
        vx_float32 minDistance; 
        vx_float32 maxDistance; 
    };

    struct PointCloudStyle
    {
        vx_float32 minDistance; 
        vx_float32 maxDistance; 
    };

    enum MouseButtonEvent
    {
        LeftButtonDown, 
        LeftButtonUp, 
        MiddleButtonDown, 
        MiddleButtonUp, 
        RightButtonDown, 
        RightButtonUp, 
        MouseMove 
    };

    typedef void (*OnKeyboardEventCallback)(void* context, vx_char key, vx_uint32 x, vx_uint32 y);
    typedef void (*OnMouseEventCallback)(void* context, MouseButtonEvent event, vx_uint32 x, vx_uint32 y);

    virtual void setOnKeyboardEventCallback(OnKeyboardEventCallback callback, void* context) = 0;
    virtual void setOnMouseEventCallback(OnMouseEventCallback callback, void* context) = 0;

    virtual void putPlanes(vx_array planes, vx_matrix model, const PlaneStyle& style) = 0;

    virtual void putPointCloud(vx_array points, vx_matrix model, const PointCloudStyle& style) = 0;


    virtual bool flush() = 0;

    virtual void close() = 0;

    virtual void setViewMatrix(vx_matrix view) = 0;

    virtual void getViewMatrix(vx_matrix view) const = 0;

    virtual void setProjectionMatrix(vx_matrix projection) = 0;
    virtual void getProjectionMatrix(vx_matrix projection) const = 0;

    virtual void setDefaultFOV(float fov) = 0;

    virtual void enableDefaultKeyboardEventCallback() = 0;
    virtual void disableDefaultKeyboardEventCallback() = 0;
    virtual bool useDefaultKeyboardEventCallback() = 0;

    virtual vx_uint32 getWidth() const = 0;
    virtual vx_uint32 getHeight() const = 0;

    virtual void putImage(vx_image image) = 0;

    virtual void putText(const std::string& text, const nvxio::Render::TextBoxStyle& style) = 0;

    virtual ~Render3D()
    {}

protected:
    Render3D(TargetType type = Render3D::UNKNOWN_RENDER, const std::string& name = "Undefined"):
        targetType(type),
        renderName(name)
    {}

    const TargetType  targetType;
    const std::string renderName;
};

NVXIO_EXPORT std::unique_ptr<Render3D> createDefaultRender3D(vx_context context, int xPos, int yPos,const std::string& title,
                                                             vx_uint32 width, vx_uint32 height);
}

#endif