CHOP_ChannelLayers.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:        CHOP_ChannelLayers.h (UI library, C++)
 *
 * COMMENTS:
 *      This class was extracted from FUI_ChannelLayers to provide scripting
 *      support for animation later.
 */

#ifndef _CHOP_CHANNELLAYERS_H_
#define _CHOP_CHANNELLAYERS_H_

#include "CHOP_API.h"
#include <OP/OP_Node.h>
#include <OP/OP_Node.h>

class CH_ScopedChannels;
class CHOP_CreateChannelChopCallback;

class CHOP_API CHOP_ChannelLayers
{
public:

    // Get/Set Active layer
    static int getActiveLayer( PRM_Parm * weight_inst_parm );
    static void setActiveLayer( PRM_Parm * weight_inst_parm, int layer_index );

    // Get the Layer Multi Parm and the layer count
    static PRM_Parm *getLayerMulti( PRM_Parm * weight_inst_parm );
    static PRM_Parm * getLayerMulti( OP_Node *node );
    static int getLayerCount( PRM_Parm * weight_inst_parm );

    // Search for a layer by comparing the name parameter value
    // returns -1 on failure
    static int getLayerIndexByName( OP_Node *node, const UT_String &name );

    // Get Layer by index
    static int getLayerIndex( PRM_Parm * weight_inst_parm );

    // Get/Set Layer Name
    static void getLayerName( PRM_Parm * weight_inst_parm, UT_String &name );
    static void setLayerName( PRM_Parm * weight_inst_parm, const UT_String &name );

    // Get a Layer Parm by name and layer_index
    // ActiveLayer and nlayers ignore the layer index
    static PRM_Parm *getLayerParm( OP_Node *node, const UT_StringHolder &parm_name, int layer_index );

    // get a layer parameter from a name and the scoped layer weight_inst_parm
    // If layer_index is given and is equal to -1, the layer index will be queried and returned in layer_index.
    // If layer_index is greater or equal to 0, the layer index will be used as as to query the parm pointer.
    static PRM_Parm *getLayerParm( PRM_Parm * weight_inst_parm, const UT_StringHolder &parm_name );
    static PRM_Parm *getLayerParm( PRM_Parm * weight_inst_parm, const UT_StringHolder &parm_name, int& layer_index );

    // get layer parameters from an array of names and the scoped layer weight_inst_parm
    // If layer_index is given and is equal to -1, the layer index will be queried and returned in layer_index.
    // If layer_index is greater or equal to 0, the layer index will be used as as to query the parm pointer.
    static void getLayerParms( UT_Array<PRM_Parm*> &ret, PRM_Parm * weight_inst_parm, const UT_StringArray &parm_names );
    static void getLayerParms( UT_Array<PRM_Parm*> &ret, PRM_Parm * weight_inst_parm, const UT_StringArray &parm_names, int& layer_index );


    // Retrieve the connected Channel CHOP given a weight_inst_parm
    static OP_Node *getLayerChannelCHOP( PRM_Parm *weight_inst_parm );

    // Retrieve all the connected Channel CHOPs given a weight_inst_parm
    // (All, not only the ones from the parm index.)
    static void getLayerChannelCHOPs( OP_Node* node, OP_NodeList &chan_chops );

    // save the undo info by name and layer index
    static void saveLayerParmForUndo( OP_Node* node, const UT_StringHolder &name, int index=0 );

    // save the undo info of a PRM_Parm
    static void saveParmForUndo( PRM_Parm *parm );

    // Bake down the effect of the layer to the previous layer
    static void mergeDownLayer( PRM_Parm *weight_inst_parm );

    // Get all the channels parms on the Channel CHOP corresponding the the layer weight parm index
    // Also returns the evaluated size of each channel parm.
    typedef UT_Array< std::pair<PRM_Parm*,int> > ParmAndSizeArray;
    static void getLayerChannelCHOPParms( PRM_Parm *weight_index_parm, ParmAndSizeArray &out );

    // Combine a source channel/weight with destination channel/weight at the parm index.
    // This modifies the dst_channel and leaves the dst_weight intact.
    static void combineChannels( PRM_Parm *src_parm, PRM_Parm *dst_parm, PRM_Parm *src_w, PRM_Parm *dst_w, int index );

    // Scope all the channel values corresponding to the weight instance parameter
    // The Channel CHOP is looked up and all the params are scoped
    static void scopeLayerChannels( CH_ScopedChannels &fsc, PRM_Parm *weight_inst_parm, fpreal t, bool on_off );

    // Create a new Layer Mixer CHOP and a base layer clip from the scopped channels
    static bool createLayerMixerCHOP(const UT_String &full_name, const CH_ScopedChannels &fsc,
        CHOP_CreateChannelChopCallback *cb);

    // Add/Remove/Edit Channels referenced by the Channel Chops
    static void addLayerChannels(OP_Node *node, int active_layer, CH_ScopedChannels &fsc); static void removeLayerChannels(OP_Node *node, int active_layer, CH_ScopedChannels &fsc);

    // Add/Remove Layers
    static OP_Node* addLayer(OP_Node *node, CH_ScopedChannels &fsc, const UT_StringHolder &layer_name );
    static bool removeLayer(OP_Node *node, PRM_Parm *parm, bool merge_down );
    static bool removeLayer(OP_Node *node, const UT_StringHolder &layer_name, bool merge_down );
};

#endif // _CHOP_CHANNELLAYERS_H_