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

#ifndef __GT_PrimTube__
#define __GT_PrimTube__

#include "GT_API.h"
#include "GT_Primitive.h"
#include "GT_Transform.h"
#include <SYS/SYS_Math.h>

/// @brief A tapered tube primitive (mapping to GEO_PrimTube)
///
/// The tube primitive represents a tapered tube along the @b Z axis.  Unlike
/// the GEO counterpart, this primitive's axis is aligned along the Z axis (not
/// the Y axis).
class GT_API GT_PrimTube : public GT_Primitive
{
public:
    /// Default constructor
    GT_PrimTube()
    {}
    /// Useful constructor
    GT_PrimTube(const GT_AttributeListHandle &attribs,
                const GT_TransformHandle &transform,
                fpreal taper,
                bool caps)
        : myTaper(SYSmax(0.0, taper))
        , myCaps(caps)
        , myAttributes(attribs)
        , GT_Primitive()
    { setPrimitiveTransform(transform); }
    /// Copy constructor
    GT_PrimTube(const GT_PrimTube &src)
        : GT_Primitive(src)
        , myTaper(src.myTaper)
        , myCaps(src.myCaps)
        , myAttributes(src.myAttributes)
    {
    }
    /// Destructor
    ~GT_PrimTube() override;

    const char *className() const override { return "GT_PrimTube"; }
    bool        save(UT_JSONWriter &w) const override;
    
    /// @{
    /// Methods defined on GT_Primitive
    int         getPrimitiveType() const override;
    /// @}

    /// Initialize a tube with
    /// - @c attribs @n
    ///   Attributes defined on the tube
    /// - @c transform @n
    ///   The transform attribute list should contain a single transform
    ///   representing the 4x4 transform of the tube.
    bool        init(const GT_AttributeListHandle &attribs,
                        const GT_TransformHandle &transform,
                        fpreal taper,
                        bool caps)
                {
                    myTaper = SYSmax(0.0, taper);
                    myCaps = caps;
                    myAttributes = attribs;
                    setPrimitiveTransform(transform);
                    return true;
                }

    /// Get a tesselation of a tube with a given set of refinement
    /// parameters.
    static GT_PrimitiveHandle   makePolygonMesh(const GT_RefineParms *parms, 
                                                fpreal taper = 1.0f);

    /// @{
    /// Accessors
    const GT_AttributeListHandle        &getAttributes() const
                                            { return myAttributes; }
    const fpreal                        &getTaper() const
                                            { return myTaper; }
    const bool                          &getCaps() const
                                            { return myCaps; }
    /// @}

    /// @{
    /// Access attributes
    const GT_AttributeListHandle        &getDetailAttributes() const override
                                            { return myAttributes; }
    /// @}

    /// @{
    /// Methods defined on GT_Primitive
    void                enlargeBounds(UT_BoundingBox boxes[],
                                      int nsegments) const override;
    int                 getMotionSegments() const override;
    int64               getMemoryUsage() const override;
    bool                refine(GT_Refine &refiner,
                               const GT_RefineParms *parms) const override;
    GT_PrimitiveHandle  doHarden() const override;
    GT_PrimitiveHandle  doSoftCopy() const override
                            { return new GT_PrimTube(*this); }
    /// @}

    /// Convenience method to refine to a polygon mesh
    GT_PrimitiveHandle  refineToPolygonMesh(
                                    const GT_RefineParms *parms) const;

protected:
    GT_AttributeListHandle      myAttributes;
    fpreal                      myTaper;
    bool                        myCaps;
};

#endif