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

#ifndef __UN_ParmUtils_h__
#define __UN_ParmUtils_h__


#include "UN_API.h"
#include "UN_GraphData.h"
#include <UT/UT_OptionEntry.h>


namespace UN_ParmUtils
{
    /// Returns true if the parameter by the given ID is valid in the graph.
    static inline bool
    isValid( const UN_GraphData *graph_data, UN_ParmID parm_id )
    {
        return graph_data && graph_data->isValid( parm_id );
    }

    /// Deletes the given parameter from the graph data structures.
    static inline void
    deleteParm( UN_GraphData *graph_data, UN_ParmID parm_id )
    {
        if( isValid( graph_data, parm_id ))
            graph_data->deleteParm( parm_id );
    }

    /// Returns the parameter name that identifies it on the node.
    static inline const UT_StringHolder &
    name( const UN_GraphData *graph_data, UN_ParmID parm_id )
    {
        return graph_data 
            ? graph_data->parmData().name( parm_id )
            : UT_StringHolder::theEmptyString;
    }

    /// Returns the parameter type that determines the type of a value.
    static inline const UT_StringHolder &
    typeName( const UN_GraphData *graph_data, UN_ParmID parm_id )
    { 
        return graph_data 
            ? graph_data->parmData().typeName( parm_id )
            : UT_StringHolder::theEmptyString;
    }

    /// Sets the parameter value using copy-assignment. 
    static inline void
    setValue( UN_GraphData *graph_data, UN_ParmID parm_id,
              const UT_OptionEntry &value )
    {
        if( graph_data )
            graph_data->parmData().setValue( parm_id, value );
    }

    /// Sets the parameter value using move-assignment. 
    static inline void
    setValue( UN_GraphData *graph_data, UN_ParmID parm_id,
              UT_OptionEntryPtr &&value ) 
    {
        if( graph_data )
            graph_data->parmData().setValue( parm_id, std::move( value ));
    }

    /// Returns the value of the parameter.
    static inline UT_OptionEntryPtr
    value( const UN_GraphData *graph_data, UN_ParmID parm_id ) 
    {
        if( !graph_data )
            return UT_OptionEntryPtr();

        auto &value = graph_data->parmData().value( parm_id );
        return value ? value->clone() : UT_OptionEntryPtr();
    }
}

#endif