FnScenegraphIterator.h

// Copyright (c) 2012 The Foundry Visionmongers Ltd. All Rights Reserved.


#ifndef KATANA_PLUGINAPIS_FNSCENEGRAPHITERATOR_FNSCENEGRAPHITERATOR_H_
#define KATANA_PLUGINAPIS_FNSCENEGRAPHITERATOR_FNSCENEGRAPHITERATOR_H_

#include <string>

#include "FnAttribute/FnAttribute.h"
#include "FnPluginSystem/FnPluginSystem.h"

#include "FnScenegraphIterator/FnScenegraphIteratorAPI.h"
#include "FnScenegraphIterator/ns.h"
#include "FnScenegraphIterator/suite/FnScenegraphIteratorSuite.h"

FNSCENEGRAPHITERATOR_NAMESPACE_ENTER
{

class FNSCENEGRAPHITERATOR_API FnScenegraphIterator
{
public:
    FnScenegraphIterator(FnSgIteratorHandle handle);
    FnScenegraphIterator();

    ~FnScenegraphIterator();

    FnScenegraphIterator(const FnScenegraphIterator& rhs);
    FnScenegraphIterator& operator=(const FnScenegraphIterator& rhs);

    bool isValid() const {return _handle != 0x0;}

    std::string getName() const;

    std::string getFullName() const;

    std::string getType() const;

    FnScenegraphIterator getFirstChild(bool evict=false) const;


    FnScenegraphIterator getNextSibling(bool evict=false) const;

    FnScenegraphIterator getParent() const;

    FnScenegraphIterator getRoot() const;

    FnAttribute::StringAttribute getPotentialChildren() const;

    FnScenegraphIterator getChildByName(const std::string &name, bool evict=false) const;

    FnScenegraphIterator getByPath(const std::string &path, bool evict=false) const;


    FnAttribute::Attribute getAttribute(const std::string &name, bool global=false) const;

    FnAttribute::StringAttribute getAttributeNames() const;

    FnAttribute::GroupAttribute getGlobalXFormGroup() const;

    void finalizeRuntime() const;


    static FnPlugStatus setHost(FnPluginHost *host);

    static FnSgIteratorHostSuite_v3 *_suite;

    FnSgIteratorHandle getHandle() const
    {
        return _handle;
    }

    static FnAttribute::GroupAttribute getOpTreeDescriptionFromFile(
            const std::string & opTreeFileName);

    static FnScenegraphIterator getIteratorFromFile(
            const std::string & opTreeFileName);

    static FnScenegraphIterator getIteratorFromOpTreeDescription(
            const FnAttribute::GroupAttribute & opTreeDescription);

protected:
    void acceptHandle(const FnScenegraphIterator &rhs);

private:

    FnSgIteratorHandle _handle;

};




}
FNSCENEGRAPHITERATOR_NAMESPACE_EXIT

#endif  // KATANA_PLUGINAPIS_FNSCENEGRAPHITERATOR_FNSCENEGRAPHITERATOR_H_