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

#ifndef __UN_Parm_h__
#define __UN_Parm_h__

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

class UN_Node;
class UN_ParmData;


// ============================================================================
/// A light-weight handle for a node parameter data.
/// 
/// The actual parameter data (UN_ParmData) is owned and managed by 
/// UN_GraphData, and UN_Parm serves as a handle for clients to refer to 
/// that parm data.

class UN_API UN_Parm : public UN_Handle
{
public:
    /// Convenience constructor for the parameter handle.
                        UN_Parm( UN_GraphData *graph_data, UN_ParmID parm_id );

    /// @{ Default destructor, constructors and assignment operators.
                        UN_Parm();
                       ~UN_Parm();
                        UN_Parm( const UN_Parm & );
                        UN_Parm( UN_Parm && );
    UN_Parm &           operator=( const UN_Parm & );
    UN_Parm &           operator=( UN_Parm && );
    /// @}

    /// @{ Returns true if the parameter exists; false otherwise.
    bool                isValid() const;
    explicit            operator bool() const
                            { return isValid(); }
    /// @}

    /// @{ Comparison operators
    bool                operator==( const UN_Parm &other ) const
                            { return UN_Handle::operator==( other ); }
    bool                operator!=( const UN_Parm &other ) const
                            { return UN_Handle::operator!=( other ); }
    /// @}

    /// Returns the node this parameter belongs to.
    UN_Node             node() const;

    /// Returns the name of the parameter.
    UT_StringHolder     name() const;

    /// Returns the name of the type of the parameter.
    UT_StringHolder     typeName() const;

    /// @{ Sets the parameter value. 
    void                setValue( const UT_OptionEntry &opt ) const;
    void                setValue( UT_OptionEntryPtr &&opt ) const;
    /// @}

    /// Returns the value of the parameter.
    UT_OptionEntryPtr   value() const;

    /// Deletes this parameter.
    void                destroy() const;

    /// Returns the unique ID of the parm data this handle refers to.
    UN_ParmID           parmID() const
                            { return UN_ParmID( dataID() ); }

protected:
    /// The parm data container for all the ports in the graph.
    UN_ParmData *       parmData() const;
};

#endif