trCore/Nodes/NodeVisitor.h

Go to the documentation of this file.

/*
* True Reality Open Source Game and Simulation Engine
* Copyright © 2021 Acid Rain Studios LLC
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 3.0 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author Maxim Serebrennik
*/
#pragma once

#include <trCore/Export.h>

#include <trBase/Base.h>
#include <trBase/SmrtPtr.h>
#include <trBase/Vec3.h>
#include <trCore/Nodes/FrameStamp.h>
#include <trCore/Nodes/Node.h>
#include <trUtil/RefStr.h>

namespace osg
{
    class NodeVisitor;
}

namespace trCore::Nodes
{
    class TR_CORE_EXPORT NodeVisitor : public trBase::Base
    {
    public:

        enum TraversalMode
        {
            TRAVERSE_NONE = 0,
            TRAVERSE_PARENTS = 1,
            TRAVERSE_ALL_CHILDREN = 2,
            TRAVERSE_ACTIVE_CHILDREN = 3
        };

        enum VisitorType
        {
            NODE_VISITOR = 0,
            UPDATE_VISITOR = 1,
            EVENT_VISITOR = 2,
            COLLECT_OCCLUDER_VISITOR = 3,
            CULL_VISITOR = 4,
            INTERSECTION_VISITOR = 5
        };

        using BaseClass = trBase::Base;                 

        const static trUtil::RefStr CLASS_TYPE;         

        NodeVisitor(TraversalMode tm = TRAVERSE_NONE, const std::string name = CLASS_TYPE);

        NodeVisitor(VisitorType type, TraversalMode tm = TRAVERSE_NONE, const std::string name = CLASS_TYPE);

        virtual const std::string& GetType() const override;

        virtual void SetName(const std::string& name);

        virtual osg::NodeVisitor* AsOSGVisitor();

        virtual const osg::NodeVisitor* AsOSGVisitor() const;

        virtual void Reset();

        inline void SetVisitorType(VisitorType type);

        inline VisitorType GetVisitorType() const;

        inline void SetTraversalNumber(unsigned int fn);

        inline unsigned int GetTraversalNumber() const;

        inline void SetFrameStamp(FrameStamp* fs);

        inline const FrameStamp* GetFrameStamp() const;

        inline void SetTraversalMask(Node::NodeMask mask);

        inline Node::NodeMask GetTraversalMask() const;

        inline void SetNodeMaskOverride(Node::NodeMask mask);

        inline Node::NodeMask GetNodeMaskOverride() const;

        inline bool ValidNodeMask(const Nodes::Node& node) const;

        inline void SetTraversalMode(TraversalMode mode);

        inline TraversalMode GetTraversalMode() const;

        inline void Traverse(Node& node);

        inline void PushOntoNodePath(Node* node);

        inline void PopFromNodePath();

        NodePath* GetNodePath();

        const NodePath* GetNodePath() const;

        virtual trBase::Vec3 GetEyePoint() const { return trBase::Vec3(0.0f, 0.0f, 0.0f); }

        virtual trBase::Vec3 GetViewPoint() const { return GetEyePoint(); }

        virtual float GetDistanceToEyePoint(const trBase::Vec3& /*pos*/, bool /*useLODScale*/) const { return 0.0f; }

        virtual float GetDistanceFromEyePoint(const trBase::Vec3& /*pos*/, bool /*useLODScale*/) const { return 0.0f; }

        virtual float GetDistanceToViewPoint(const trBase::Vec3& /*pos*/, bool /*useLODScale*/) const { return 0.0f; }

    protected:

        trBase::SmrtPtr<osg::NodeVisitor> mNodeVisitor;

        ~NodeVisitor();
    };
}