OP_ContextOptionsMicroNode.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.
 *
 * NAME:        OP_DataMicroNode.h (OP Library, C++)
 *
 * COMMENTS:    DEP_MicroNode subclass representing an OP_Node's output data.
 */

#ifndef __OP_CONTEXTOPTIONSMICRONODE_H_INCLUDED__
#define __OP_CONTEXTOPTIONSMICRONODE_H_INCLUDED__

#include "OP_API.h"
#include "OP_Version.h"
#include <DEP/DEP_MicroNode.h>

class OP_API OP_ContextOptionsMicroNode : public DEP_MicroNode
{
public:
                            OP_ContextOptionsMicroNode();

    const char *            className() const override
                                { return "OP_ContextOptionsMicroNode"; }

    /// update() is used by users of micro-nodes to mark this node as clean at
    /// the given time t.
    void                    update(fpreal t) override;

    /// requiresUpdate() specifies if the micro-node was dirtied, possibly
    /// based on the time t (if isTimeDependent() is true).
    bool                    requiresUpdate(fpreal t) const override;

    /// update() is used by users of micro-nodes to mark this node as clean for
    /// the given context options.
    void                    updateOptions(DEP_ContextOptionsReadHandle options,
                                const DEP_ContextOptionsStack *optstack);

    /// requiresUpdate() specifies if the micro-node was dirtied
    /// based on a change to context options.
    bool                    requiresUpdateOptions(
                                DEP_ContextOptionsReadHandle options,
                                const DEP_ContextOptionsStack *optstack) const;

    /// Returns the options and values _used_ in the last cook of this data.
    DEP_ContextOptionsReadHandle getLastUsedContextOptions() const
                            { return myLastUsedContextOptions; }
    /// Returns all options and values provided to the last cook of this data.
    const DEP_ContextOptionsReadHandle &getLastAllContextOptions() const
                            { return myLastAllContextOptions; }
    DEP_ContextOptionsStack *getLastUsedContextOptionsStack() const
                            { return myLastUsedContextStack.get(); }
    const UT_StringArray    &getLastMissingContextOptions() const
                            { return myLastMissingContextOptions; }

    fpreal                  lastUpdateTime() const
                                { return myLastUpdateTime; }
    bool                    isEqualToLastUpdateTime(fpreal t) const
                                { return isSameTime(t, myLastUpdateTime); }

private:
    DEP_ContextOptionsHandle                     myLastUsedContextOptions;
    UT_UniquePtr<DEP_ContextOptionsStack>        myLastUsedContextStack;
    DEP_ContextOptionsReadHandle                 myLastAllContextOptions;
    UT_StringArray                               myLastMissingContextOptions;
    fpreal                                       myLastUpdateTime;
};

#endif // __OP_CONTEXTOPTIONSMICRONODE_H_INCLUDED__