HOM_LopExpansionState.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.
 *
 * COMMENTS:
 *      Class used to represent the scene graph tree expansion state, and
 *      associated expansion effect locking information.
 */

#ifndef __HOM_LopExpansionState_h__
#define __HOM_LopExpansionState_h__

#include "HOM_API.h"
#include "HOM_Errors.h"
#include "HOM_Module.h"

SWIGOUT(%rename(LopExpansionState) HOM_LopExpansionState;)

SWIGOUT(%feature("notabstract") HOM_LopExpansionState;)
class HOM_API HOM_LopExpansionState
{
public:
#ifdef SWIG
    %extend
{
    HOM_LopExpansionState()
    { return HOM().newLopExpansionState(); }
}
#else
    HOM_LopExpansionState()
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_LopExpansionState()
    { HOM_DESTRUCT_OBJECT(this) }
#endif

    // Let swig know we're overriding __repr__ for this class so it doesn't
    // provide its own __repr__.
    virtual std::string __repr__() = 0;

    SWIGOUT(%ignore opaqueExpandedPinnedPaths;)
    virtual void *opaqueExpandedPinnedPaths() = 0;
    virtual bool setPinnedPathExpanded(const char *path, bool expanded) = 0;
    SWIGOUT(%ignore opaqueSetExpandedPinnedPaths;)
    virtual void opaqueSetExpandedPinnedPaths(void *expanded_paths) = 0;
    SWIGOUT(%ignore opaqueExpandedPaths;)
    virtual void *opaqueExpandedPaths() = 0;
    virtual bool setPathExpanded(const char *path, bool expanded) = 0;
    SWIGOUT(%ignore opaqueSetExpandedPaths;)
    virtual void opaqueSetExpandedPaths(void *expanded_paths) = 0;

    SWIGOUT(%ignore opaqueExpansionLockedPrimitives;)
    virtual void *opaqueExpansionLockedPrimitives() = 0;
    SWIGOUT(%ignore opaqueExpansionLockedExpandedPrimitives;)
    virtual void *opaqueExpansionLockedExpandedPrimitives() = 0;
    SWIGOUT(%ignore opaqueSetPrimitiveExpansionLocked;)
    virtual bool opaqueSetPrimitiveExpansionLocked(const char *path,
            void *expanded_subpaths,
            bool preserve_descendant_expansion) = 0;
    virtual bool setPrimitiveExpansionUnlocked(const char *path,
            bool preserve_descendant_expansion = true) = 0;

    virtual HOM_BinaryString dumps() = 0;
    virtual void loads(HOM_BinaryString expansion_str) = 0;

#ifdef SWIG
%extend
{
    InterpreterObject expandedPinnedPaths()
    { return HOMincRef((InterpreterObject)self->
             opaqueExpandedPinnedPaths()); }
    void setExpandedPinnedPaths(InterpreterObject expanded_paths)
    { self->opaqueSetExpandedPinnedPaths(expanded_paths); }
    InterpreterObject expandedPaths()
    { return HOMincRef((InterpreterObject)self->
             opaqueExpandedPaths()); }
    void setExpandedPaths(InterpreterObject expanded_paths)
    { self->opaqueSetExpandedPaths(expanded_paths); }

    InterpreterObject expansionLockedPrimitives()
    { return HOMincRef((InterpreterObject)self->
             opaqueExpansionLockedPrimitives()); }
    InterpreterObject expansionLockedExpandedPrimitives()
    { return HOMincRef((InterpreterObject)self->
             opaqueExpansionLockedExpandedPrimitives()); }
    SWIGOUT(%kwargs setPrimitiveExpansionLocked;)
    bool setPrimitiveExpansionLocked(const char *path,
        InterpreterObject expanded_subpaths = nullptr,
        bool preserve_descendant_expansion = true)
    { return self->opaqueSetPrimitiveExpansionLocked(path,
        expanded_subpaths, preserve_descendant_expansion); }
}
#endif
};

#endif