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

#ifndef __UN_GraphConfig_h__
#define __UN_GraphConfig_h__

#include "UN_API.h"
#include <UT/UT_StringHolder.h>


// ============================================================================
/// The graph configuration class. 
/// It contains info about specific aspects of a graph, eg,
/// whether nodes require alphanumeric and/or unique names.
class UN_GraphConfig
{
public:
    /// Set the flag to ensure the graph item names (such as node or 
    /// sticky note names) are both alphanumeric and also unique 
    /// among their siblings in the subnet.
    /// These two options are usually set in tandem, for pattern matching 
    /// in scripts and for identifying nodes using paths.
    void                setForceValidUniqueGraphItemNames( bool flag ) 
                            { 
                                setForceValidGraphItemNames( flag );
                                setForceUniqueGraphItemNames( flag );
                            }

    /// @{ A flag that ensures all graph items (nodes, sticky notes, etc) 
    /// have an alphanumeric name.
    bool                shouldForceValidGraphItemNames() const
                            { return myForceValidGraphItemNames; }
    void                setForceValidGraphItemNames( bool flag ) 
                            { myForceValidGraphItemNames = flag; }
    /// @}
    
    /// @{ A set of additional characters that are legal in node names.
    const UT_StringHolder & graphItemNameSafeChars() const
                            { return myGraphItemNameSafeChars; }
    void                setGraphItemNameSafeChars( 
                                const UT_StringRef &safe_chars )
                            { myGraphItemNameSafeChars = safe_chars; }
    /// @}

    /// @{ A flag that ensures all the nodes have names that are unique among 
    /// their siblings within a subnet.
    bool                shouldForceUniqueGraphItemNames() const
                            { return myForceUniqueGraphItemNames; }
    void                setForceUniqueGraphItemNames( bool flag ) 
                            { myForceUniqueGraphItemNames = flag; }
    /// @}

    /// @{ A flag that indicates whether the graph should use the node types
    /// registered with the UN manager. Setting this flag to true
    /// validates the node type name when creating a new node.
    bool                usesRegistryNodeTypes() const
                            { return myUsesRegistryNodeTypes; }
    void                useRegistryNodeTypes( bool flag ) 
                            { myUsesRegistryNodeTypes = flag; }
    /// @}

    /// @{ A flag that ensures all the ports have an alphanumeric name.
    bool                shouldForceValidPortNames() const
                            { return myForceValidPortNames; }
    void                setForceValidPortNames( bool flag ) 
                            { myForceValidPortNames = flag; }
    /// @}
    
    /// @{ A flag that ensures an alphanumeric node type names.
    /// This is useful for future-proofing namespacing, versioning, etc.
    bool                shouldForceValidPortTypeNames() const
                            { return myForceValidPortTypeNames; }
    void                setForceValidPortTypeNames( bool flag ) 
                            { myForceValidPortTypeNames = flag; }
    /// @}

private:
    /// Ensure that graph item names (nodes, sticky notes) are alphanumeric.
    bool                myForceValidGraphItemNames = false;

    /// Ensure that graph item names (nodes, sticky notes) are unique 
    /// among the siblings within a subnet.
    bool                myForceUniqueGraphItemNames = false;

    /// Uses node types found in the registry for node initialization,
    /// and acquiring its aspects (eg, input/outputs, parameters, etc).
    bool                myUsesRegistryNodeTypes = false;

    /// Ensure that port names are alphanumerci.
    bool                myForceValidPortNames = false;

    /// Ensure that port type names are alphanumeric.
    bool                myForceValidPortTypeNames = false;

    /// Extra characters that are legal in the graph item names (nodes, etc),
    /// in addition to the standard C-var style alphanumerics.
    UT_StringHolder     myGraphItemNameSafeChars;
};


#endif