GU_AgentShapeDeformer.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_AgentShapeDeformer.h (GU Library, C++)
 *
 */

#ifndef __GU_AgentShapeDeformer__
#define __GU_AgentShapeDeformer__

#include "GU_API.h"
#include "GU_AgentShapeLib.h"

#include <SYS/SYS_Types.h>
#include <UT/UT_BoundingBox.h>
#include <UT/UT_IntrusivePtr.h>
#include <UT/UT_NonCopyable.h>
#include <UT/UT_StringHolder.h>

class GU_Agent;
class GU_Detail;

class GU_AgentShapeDeformer;
using GU_AgentShapeDeformerPtr = UT_IntrusivePtr<GU_AgentShapeDeformer>;
using GU_AgentShapeDeformerConstPtr =
    UT_IntrusivePtr<const GU_AgentShapeDeformer>;

/// Defines a deformer for an agent shape.
class GU_API GU_AgentShapeDeformer
    : public UT_IntrusiveRefCounter<GU_AgentShapeDeformer>
{
public:
    GU_AgentShapeDeformer(const UT_StringHolder &name);

    virtual ~GU_AgentShapeDeformer() = default;

    UT_NON_COPYABLE(GU_AgentShapeDeformer);

    /// Unique identifier for the deformer. This is used when serializing
    /// layers to JSON.
    const UT_StringHolder &name() const { return myName; }

    /// Deform the provided detail, which was unpacked from the given shape
    /// binding (shape & transform index) and agent.
    ///
    /// The transform index can be used for deformers that need to know the
    /// shape's transform in order to perform the deformation correctly (e.g.
    /// for skinning). Deformers are not responsible for applying the transform
    /// to the geometry - this is performed after the deformer is executed.
    /// Note that the transform index may be -1 if the shape was not attached
    /// to a joint.
    virtual void deform(GU_Detail &gdp,
                        const GU_AgentShapeLib::Shape &src_shape,
                        exint xform_idx,
                        const GU_Agent &src_agent) const = 0;

    /// Compute an approximate bounding box for the deformed shape.
    /// Similar to deform(), the shape binding's transform and bounds scale are
    /// applied after calling this method.
    ///
    /// The default implementation just uses the bounding box of the source
    /// shape (equivalent to how bounds would be computed for a static shape
    /// binding).
    virtual void computeBounds(UT_BoundingBox &box,
                               const GU_AgentShapeLib::Shape &src_shape,
                               exint xform_idx,
                               const GU_Agent &src_agent) const;

private:
    UT_StringHolder myName;
};

#endif