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

#ifndef __GU_PackedDiskSequence__
#define __GU_PackedDiskSequence__

#include "GU_PackedSequence.h"
#include "GU_PackedDisk.h"
#include <UT/UT_StringHolder.h>
#include <UT/UT_StringArray.h>

class GA_PrimitiveFactory;
class UT_MemoryCounter;

/// Geometry file procedural
class GU_API GU_PackedDiskSequence : public GU_PackedSequence
{
public:
    using this_type = GU_PackedDiskSequence;
    using parent_type = GU_PackedSequence;

             GU_PackedDiskSequence();
             GU_PackedDiskSequence(const GU_PackedDiskSequence &src);
            ~GU_PackedDiskSequence() override;

    /// Convenience method to create a packed primitive in the destination
    /// detail.
    ///
    /// Returns a NULL pointer if the process fails.
    static GU_PrimPacked        *packedDiskSequence(GU_Detail &dest,
                                        const UT_StringArray &filenames,
                                        fpreal index,
                                        WrapMode wrap);

    /// Install the procedural
    static void install(GA_PrimitiveFactory *prim);

    /// Get the type ID for the GU_PackedDiskSequence primitive type.
    static GA_PrimitiveTypeId   typeId() { return theTypeId; }

    /// @{
    /// Implementation of GU_PackedImpl interface
    GU_PackedFactory    *getFactory() const override;
    GU_PackedImpl       *copy() const override;
    void                 clearData() override;

    bool    isValid() const override;
    bool    load(GU_PrimPacked *prim, const UT_Options &options,
                 const GA_LoadMap &map) override
            {
                return loadFrom(prim, options, map);
            }
    bool    supportsJSONLoad() const override { return true; }
    bool    loadFromJSON(
                    GU_PrimPacked *prim,
                    const UT_JSONValueMap &options,
                    const GA_LoadMap &map) override
            {
                return loadFrom(prim, options, map);
            }
    void    update(GU_PrimPacked *prim, const UT_Options &options) override;
    bool    save(UT_Options &options, const GA_SaveMap &map) const override;
    bool    isLoaded() const override;

    /// Report memory usage (includes all shared memory)
    int64   getMemoryUsage(bool inclusive) const override;

    /// Count memory usage using a UT_MemoryCounter in order to count
    /// shared memory correctly.
    void    countMemory(UT_MemoryCounter &counter,
                        bool inclusive) const override;
    /// @}

    /// @{
    /// Member data accessors for intrinsics
    void filenames(UT_StringArray &files) const;
    void intrinsicFilenames(const GU_PrimPacked *prim, UT_StringArray &files) const
    { filenames(files); }
    void setFilenames(GU_PrimPacked *prim, const UT_StringArray &files);
    /// @}

    UT_StringHolder  filename(exint index) const;
        
    using CacheItem = GU_PackedDisk::CacheItem;

    GU_ConstDetailHandle        getPointCloud() const;

    InstanceKey         getInstanceKey(exint quanize_steps) const override;

    GU_ConstDetailHandle getClosestGeometry(fpreal t) const;

protected:
    template <typename T>
    bool        loadFrom(GU_PrimPacked *prim, const T &options, const GA_LoadMap &map);

    exint       sequenceSize() const override;
    bool        sequenceBounds(exint index, UT_BoundingBox &box) const override;
    bool        sequenceVisibleBounds(
                        exint index,
                        UT_BoundingBox &box) const override;
    void        sequenceVelocityRange(
                        exint index,
                        UT_Vector3 &min,
                        UT_Vector3 &max) const override;
    void        sequenceWidthRange(
                        exint index,
                        fpreal &min,
                        fpreal &max) const override;

    GU_ConstDetailHandle    sequencePointCloud(exint index) const override;
    GU_ConstDetailHandle    sequenceGeometry(exint index) const override;

    UT_Array<CacheItem> myCache;

private:
    static GA_PrimitiveTypeId theTypeId;
};

#endif