UN_Context.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:        UN_Context.h ( UN Library, C++)
 *
 * COMMENTS:
 *      
 */

#ifndef __UN_Context_h__
#define __UN_Context_h__

#include "UN_API.h"
#include "UN_Graph.h"
#include <UT/UT_UniquePtr.h>

class UN_GraphData;


// ============================================================================
/// The owner of the graph and its data.
/// 
/// Note, unlike UN_Graph and UN_Node, etc, this class is not a handle.
/// It is an owner of the graph data (rather than a reference to it).
/// It is also a provider of other aspcets of the graph (eg, node types, 
/// port types, etc).
///
/// One consequence of this is that this class has a mix of const and non-const
/// methods (handle classes have all const methods). Non-const methods
/// return types that can be modified, while const methods return the ones
/// that are not changeable.

// TODO: FIXME: How does UN_Context fit into UN_NodeCategory,
//      UN_PortType, UN_ParmType, all available from the UN_Framework
//      registry? 
//      - Its constructor will take a list of category names,
//        and it will hold to a UN_NodeCategory references in a member array.
//      - UN_NodeCategory list is obtained from UN_Framework which
//        discovers node categories, port types, and parm types.
//      - UN_NodeCategory will provide list of UN_NodeTypes for UN_Nodes
//        that can live inside the UN_Graph.
//      - UN_NodeCategory will also provide a list of UN_PortTypes
//        that UN_Nodes can use. Port type gives connectivity and color hints
//        to the UI; it will also allow support for compound types (structs).
class UN_API UN_Context
{
public:
    /// @{ Constructor and destructor
                         UN_Context();
                        ~UN_Context();
    /// @}

    /// Returns a handle of (reference to) the graph owned by this class.
    // Note: this class is not a handle, so unlike handle classes
    //       (eg, UN_Node) it needs to have non-const methods if they
    //       return a modifiable object. Since UN_Graph is a handle to a
    //       non-const graph (ie, users can modify this graph using this handle)
    //       this method is non-const.
    UN_Graph            graph()     // non-const
                            { return UN_Graph( myGraphData.get() ); }


    // TODO: FIXME: remove it
    /// Returns the graph data structures object.
    /// For use in UN library classes, mainly for unit testing.
    /// Should not be needed outside of the UN library.
    UN_GraphData *      graphData()
                            { return myGraphData.get(); }

private:
    /// Holds data about the graph.
    UT_UniquePtr< UN_GraphData >    myGraphData;
};


#endif