Representation.h

// This file is a part of the OpenSurgSim project.
// Copyright 2013-2016, 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_GRAPHICS_REPRESENTATION_H
#define SURGSIM_GRAPHICS_REPRESENTATION_H

#include "SurgSim/Framework/Representation.h"

#include "SurgSim/Math/RigidTransform.h"

#include <unordered_set>

namespace SurgSim
{

namespace Graphics
{

class Manager;
class Material;
class UniformBase;

class Representation : public SurgSim::Framework::Representation
{
public:

    static const std::string DefaultGroupName;
    static const std::string DefaultHudGroupName;

    explicit Representation(const std::string& name);

    virtual ~Representation();

    virtual bool setMaterial(std::shared_ptr<SurgSim::Framework::Component> material) = 0;

    virtual std::shared_ptr<Material> getMaterial() const = 0;

    void setMaterialReference(const std::string& materialName);

    std::string getMaterialReference() const;

    virtual void clearMaterial() = 0;

    virtual void setDrawAsWireFrame(bool val) = 0;

    virtual bool getDrawAsWireFrame() const = 0;

    virtual void setGenerateTangents(bool value) = 0;

    virtual bool isGeneratingTangents() const = 0;

    virtual void update(double dt) = 0;

    virtual bool addGroupReference(const std::string& name);


    void addGroupReferences(const std::vector<std::string>& groups);

    void setGroupReferences(const std::vector<std::string>& groups);

    void setGroupReference(const std::string& group);

    std::vector<std::string> getGroupReferences() const;

    bool removeGroupReference(const std::string& group);

    void clearGroupReferences();

    virtual void addUniform(std::shared_ptr<UniformBase> uniform) = 0;

    virtual void addUniform(const std::string& type, const std::string& name, const boost::any& value) = 0;

    virtual void setUniforms(const std::vector<std::shared_ptr<UniformBase>>& uniforms) = 0;

    virtual std::vector<std::shared_ptr<UniformBase>> getUniforms() const = 0;

    bool doWakeUp() override;

private:
    std::unordered_set<std::string> m_groups;

    bool checkAwake(const std::string& functionName);

    std::string m_materialReference;
};

};  // namespace Graphics
};  // namespace SurgSim

#endif  // SURGSIM_GRAPHICS_REPRESENTATION_H