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

#ifndef __UNI_Include_h__
#define __UNI_Include_h__

// Include IDs to reference UNI objects, like graphs, nodes, etc.
#include "UNI_ID.h"
#include "UNI_SessionID.h"
#include <UT/UT_StringHolder.h>

/// Specifies the port kind, ie, wheter it is an input or an output port.
enum class UNI_PortKind
{ 
    Invalid,    // Unknown port kind; used for uninitialized state or errors.
    Input,      // Represents an input port.
    Output      // Represents an output port.
};

/// Specifies the visual shape of the port in the UI.
enum class UNI_PortShape
{ 
    Default,    // Default shape, if nothing specific is required
    Dot,        // Round dot shape
    Box,        // Spare box shape
};

/// Specifies the visual line shape of the connection wires in the UI.
/// This is saved as an int on the Apex Graph so do not reorder these !
enum UNI_WireStyle
{
    Straight,   // Straight line
    Rounded,    // Round connections
};

/// Basic information about signature
class UNI_Signature
{
public:
    /// Constructor
    UNI_Signature( const UT_StringRef &name, const UT_StringRef &label )
        : myName( name )
        , myLabel( label )
    {}
 
    /// Returns the identification name of the signature. 
    /// It could be a name, id, or a function signature, etc.
    const UT_StringHolder &     name() const    { return myName; }

    /// Returns the label used in GUI menus.
    const UT_StringHolder &     label() const   { return myLabel; }

private:
    UT_StringHolder myName;     // Signature name/id/function 
    UT_StringHolder myLabel;    // Text used in GUI menus
};

#endif