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

#ifndef __GT_PrimChannel__
#define __GT_PrimChannel__

#include "GT_API.h"
#include "GT_Primitive.h"
#include "GT_GEOPrimCollect.h"
#include "GT_Transform.h"

/// @brief A channel primitive
/// @endcode
class GT_API GT_PrimChannel : public GT_Primitive
{
public:
    /// Default constructor
    GT_PrimChannel(const GU_ConstDetailHandle &gdh, const GEO_Primitive *prim);
    /// Destructor
    ~GT_PrimChannel() override;

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

    GT_PrimitiveHandle  doSoftCopy() const override
                                    { return new GT_PrimChannel(*this); }
    GT_PrimitiveHandle  doHarden() const override;

    /// @{
    /// Methods defined on GT_Primitive
    void                enlargeBounds(UT_BoundingBox boxes[],
                                      int nsegments) const override;
    int                 getMotionSegments() const override;
    int64               getMemoryUsage() const override;
    /// @}
    
    /// @{
    /// Methods defined on GT_Primitive
    int                 getPrimitiveType() const override
                            { return GT_PRIM_CHANNEL; }
    /// @}

    const GEO_Primitive *getGeoPrimitive() const
                            { return getPrimitive(); }

protected:

private:
    const GEO_Primitive *getPrimitive() const;

    GU_ConstDetailHandle                myDetail;
    GA_Offset                           myPrimOffset;
};

/// Trivial collector class for Channel - 1 GT_PrimChannel per Channel primitive
class GT_API GT_GEOPrimCollectChannel: public GT_GEOPrimCollect
{
public:
                    GT_GEOPrimCollectChannel() {}
                   ~GT_GEOPrimCollectChannel() override {}

    GT_GEOPrimCollectData *
                beginCollecting(const GT_GEODetailListHandle &geometry,
                                const GT_RefineParms *parms) const override;

    GT_PrimitiveHandle         collect(const GT_GEODetailListHandle &,
                                       const GEO_Primitive *const* prim_list,
                                       int,
                                       GT_GEOPrimCollectData *) const override;

    GT_PrimitiveHandle
                endCollecting(const GT_GEODetailListHandle &geometry,
                                GT_GEOPrimCollectData *data) const override;
};

#endif