GT_PrimCharacterScene.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:        GT_CharacterScene.h (GT Library, C++)
 *
 * COMMENTS:
 */
#ifndef GT_PrimCharacterScene_h
#define GT_PrimCharacterScene_h

#include "GT_API.h"
#include "GT_Primitive.h"

#include <GU/GU_DetailHandle.h>
#include <UT/UT_NonCopyable.h>
#include <UT/UT_Pair.h>
#include <UT/UT_Array.h>

class GU_PrimPacked;

class GT_API GT_PrimCharacterScene : public GT_Primitive
{
public:
    /// Contains a list of either shape, skel, or rig prims
    using Component = std::pair<UT_StringHolder, GU_ConstDetailHandle>;
    /// A character will have a name and at least one shape, skel, and rig prim
    struct Character {
        UT_StringHolder name;
        UT_Array<Component> shapes;
        UT_Array<Component> skels;
        UT_Array<Component> rigs;

        Character(
            const UT_StringHolder &name,
            const UT_Array<Component> &shapes,
            const UT_Array<Component> &skels,
            const UT_Array<Component> &rigs)
        : name(name)
        , shapes(shapes)
        , skels(skels)
        , rigs(rigs)
        {}
    };

    GT_PrimCharacterScene(const GU_ConstDetailHandle &prim_gdh);
    ~GT_PrimCharacterScene() override;

    UT_NON_COPYABLE(GT_PrimCharacterScene);

    void addPrim(const GU_PrimPacked *prim);

    int getPrimitiveType() const override { return GT_PRIM_CHARACTER_SCENE; }

    const char *className() const override { return "gt_CharacterScene"; }

    /// An array of bounding boxes is passed in.  There is a bounding box for
    /// each segement.  Each bounding box should be enlarged appropriately.
    void        enlargeBounds(UT_BoundingBox boxes[],
                                        int nsegments) const override { /* TODO */ }
    /// Return the number of motion segments defined on the geometry
    /// By default, this simply returns the number of segments on P.
    int         getMotionSegments() const override { return 0; /* TODO */ }

    /// Return an approximate memory usage.  Since data may be shared, this
    /// will always be an over-estimation.
    int64       getMemoryUsage() const override { return 0; /* TODO */ }

    /// Create a copy of the primitive, referencing all the source data
    /// This can return a NULL pointer, but it would be better to implement it
    /// properly.
    GT_PrimitiveHandle  doSoftCopy() const override { return nullptr; /* TODO */ }

    GU_ConstDetailHandle findAShape() const;

    // array contains a shape, a skel, and a rig in that order
    Character findACharacter() const;
    UT_Array<Character> findAllCharacters() const;

    GU_ConstDetailHandle getDetail() const {return myPrimDetail;}

    bool hasScenePrim() const;
    bool hasConstraintsPrim() const;
    GU_ConstDetailHandle getScenePrim() const;
    GU_ConstDetailHandle getConstraintsPrim() const;

private:
    struct Tree;

    GU_ConstDetailHandle         myPrimDetail;
    Tree *mySceneTree = nullptr;
};

#endif