HOM/HOM_hipFile.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 */

#ifndef __HOM_hipFile_h__
#define __HOM_hipFile_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_Node.h"
#include <vector>

SWIGOUT(%rename(hipFile) HOM_hipFile;)
class HOM_API HOM_hipFile
{
public:
    virtual ~HOM_hipFile()
    {}

    virtual std::string __repr__() throw(HOM_Error) = 0;

    SWIGOUT(%kwargs save;)
    virtual void save(const char *file_name = NULL) 
        throw(HOM_OperationFailed, HOM_Error) = 0;

    virtual void saveAndIncrementFileName()
        throw(HOM_OperationFailed, HOM_Error) = 0;

    virtual void saveAsBackup() 
        throw(HOM_OperationFailed, HOM_Error) = 0;

    virtual std::string name() throw(HOM_Error) = 0;

    SWIGOUT(%kwargs clear;)
    virtual void clear(bool suppress_save_prompt = false)
        throw(HOM_OperationFailed, HOM_Error) = 0;

    SWIGOUT(%kwargs load;)
    virtual void load(const char *file_name, 
            bool suppress_save_prompt = false) 
        throw(HOM_LoadWarning, HOM_OperationFailed, HOM_TypeError,
            HOM_Error) = 0;

    SWIGOUT(%kwargs merge;)
    virtual void merge(const char *file_name, 
            const char *node_pattern = "*",
            bool overwrite_on_conflict = false)
        throw(HOM_LoadWarning, HOM_OperationFailed, HOM_TypeError,
            HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "collisionNodesIfMerged(self, file_name, node_pattern=\"*\")"
        " -> tuple of Nodes") collisionNodesIfMerged;)
    SWIGOUT(%kwargs collisionNodesIfMerged;)
    virtual std::vector<HOM_ElemPtr<HOM_Node> > collisionNodesIfMerged(
            const char *file_name, const char *node_pattern = "*")
        throw(HOM_OperationFailed, HOM_TypeError, HOM_Error) = 0;

    virtual bool isLoadingHipFile() throw(HOM_Error) = 0;

    virtual bool isShuttingDown() throw(HOM_Error) = 0;
    
    virtual bool hasUnsavedChanges() throw(HOM_Error) = 0;
};

#endif

---