PDG_FrameUtils.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.
 *
 * COMMENTS:
 */

#ifndef __PDG_FRAME_UTILS_H__
#define __PDG_FRAME_UTILS_H__

#include "PDG_API.h"

#include "PDG_NodeTypes.h"
#include "PDG_WorkItemTypes.h"

#include <UT/UT_Array.h>

/**
 * Utiliy class for working with work items over a frame range
 */
class PDG_API PDG_FrameUtils
{
public:
    /// Array of arrays of workitems, used when splitting a list of
    /// work items into batches by frame.
    using BatchSplitArray   = UT_Array<PDG_WorkItemArray>;

public:
    /// Batches work items by frame. Iterates over a list of work items and
    /// attempts to extract N contiguous lists that span an increasing frame
    /// range.
    static void                 batchWorkItemsByFrame(
                                    BatchSplitArray& batches,
                                    PDG_WorkItemArray& missing_items,
                                    const PDG_WorkItemArray& work_items,
                                    const PDG_NodeArray* input_nodes,
                                    bool save_missing = true);

    /// Detects the start, end, and step frame range values from a list of
    /// work items. Ignores work items that are missing a frame range.
    static bool                 detectFrameRange(
                                    fpreal& start,
                                    fpreal& end,
                                    fpreal& step,
                                    const PDG_WorkItemArray& work_items,
                                    exint step_precision=100);

    /// Detects the start, end, and step frame range values from a list of
    /// frame values.
    static bool                 detectFrameRange(
                                    fpreal& start,
                                    fpreal& end,
                                    fpreal& step,
                                    const UT_FprealArray& frames,
                                    exint step_precision=100);

private:
    /// Internal frame detection implementation, assumes that the frame values
    /// have been sorted in ascending order
    static bool                 detectFrameRangeSorted(
                                    fpreal& start,
                                    fpreal& end,
                                    fpreal& step,
                                    const UT_FprealArray& frames,
                                    exint step_precision=100);
};

#endif