libopensurgsim-dev 0.7.0-6ubuntu1 / usr / include / SurgSim / Blocks / ImplicitSurface.h

// This file is a part of the OpenSurgSim project.
// Copyright 2015, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SURGSIM_BLOCKS_IMPLICITSURFACE_H
#define SURGSIM_BLOCKS_IMPLICITSURFACE_H

#include "SurgSim/Framework/Component.h"
#include "SurgSim/Framework/SceneElement.h"
#include "SurgSim/Graphics/Uniform.h"
#include "SurgSim/Math/Vector.h"

namespace SurgSim
{
namespace Blocks
{
static const std::string GROUP_IMPLICIT_SURFACE = "ImplicitSurface";

/// Builds a series of SceneElements enabling the rendering of a screen-space surface, all graphics objects that
/// should be rendered as a surface need to be in the render group GROUP_IMPLICIT_SURFACE.
/// The rest is done by the graphics system.
/// All of the elements added are \sa RenderPass elements
/// \param view the view to pull screen space dimensions from
/// \param light the scene light to be used to shade the surface
/// \param lightMapPass scene element containing the render pass for shadow casters
/// \param sphereRadius the radius in meters that each point sprite sphere should have
/// \param sphereScale the scaling factor for the point sprite sphere based on distance from the camera
/// \param blurRadius sampling radius for the blur pass
/// \param diffuseColor the color to use for the final surface shading
/// \param specularColor the color to use for the specular highlight on the surface
/// \param diffuseEnvMap the cube map to use for the diffuse environmental mapping
/// \param diffusePct the amount to blend the environment map with the rest of diffuse lighting
/// \param specularEnvMap the cube map to use for the specular environmental mapping
/// \param specularPct the amount to blend the environment map with the rest of specular lighting
/// \param shininess the shininess factor for the specular highlight
/// \param shadowBias the bias to be used when determining something is in shadow or not, increasing this can help
/// 	   remove sharp edges at glancing angles
/// \param shadowIntensity the general intensity of the shadow, 1 means everything in shadow will be black, 0 means
///        there won't be any shadows at all
/// \param showDebug whether to show debug information
std::vector<std::shared_ptr<Framework::SceneElement>> createImplicitSurfaceEffect(
		std::shared_ptr<Framework::Component> view,
		std::shared_ptr<Framework::Component> light,
		std::shared_ptr<Framework::SceneElement> lightMapPass,
		float sphereRadius,
		float sphereScale,
		float blurRadius,
		const Math::Vector4f& diffuseColor,
		const Math::Vector4f& specularColor,
		const std::string diffuseEnvMap,
		float diffusePct,
		const std::string specularEnvMap,
		float specularPct,
		float shininess,
		float shadowBias,
		float shadowIntensity,
		bool showDebug);

} // Blocks
} // SurgSim

#endif // SURGSIM_BLOCKS_IMPLICITSURFACE_H