GD_PrimPoly.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:        Geometry Library (C++)
 *
 * COMMENTS:    polygon definition
 * 
 */

#ifndef __GD_PrimPoly_H__
#define __GD_PrimPoly_H__

#include "GD_API.h"
#include "GD_Face.h"
#include "GD_PrimType.h"
#include <iosfwd>

class GD_Detail;
class UT_MemoryCounter;

class GD_API GD_PrimPoly : public GD_Face
{
public:
    GD_PrimPoly(GD_Detail *d, GA_Offset offset = GA_INVALID_OFFSET)
        : GD_Face(d, offset)
    { }
    ~GD_PrimPoly() override {}

    /// Report memory usage
    int64                getMemoryUsage() const override;

    /// Count memory usage using a UT_MemoryCounter in order to count
    /// shared memory correctly.
    /// NOTE: This should always include sizeof(*this).
    void                 countMemory(UT_MemoryCounter &counter) const override;

    const GA_PrimitiveJSON              *getJSON() const override;

    const GA_PrimitiveDefinition         &getTypeDef() const override;

    // Build a new polygon and insert it into the given detail.
    static GD_PrimPoly  *build(GD_Detail *d, int npts, int closed = 0,
                               int appendPts = 1);

    unsigned             getOrder() const override;

    // Evaluate one point (when du=0), or the du-th derivative.
    // Return 0 if successful, and -1 otherwise.
    int                 evaluate(float u, UT_Vector3 &pos,
                                 unsigned du=0, int uOffset=-1) const override;
    bool                evaluate(GA_Offset vtx, GA_AttributeRefMap &h,
                                fpreal u, uint du=0,
                                int uoffset=-1) const override;

    // Build a trim loop (which will be open unless the face is closed). The
    // loop is build every time you call this method, so it's expensive. You
    // must free the loop yourself when you are done with it. The trim pieces
    // are generated in the [ustart,ustop] or [ustop,ustart] interval, where
    // ustart and ustop are parametric values.
    GD_TrimLoop         *trimLoop(float ustart, float ustop) const override;
    int                 breakCount() const override;

protected:
    /// All subclasses should call this method to register the poly intrinsics.
    /// @see GA_AttributeIntrinsic
    static GA_IntrinsicManager::Registrar
                registerIntrinsics(GA_PrimitiveDefinition &definition)
                        { return GD_Face::registerIntrinsics(definition); }

    // We don't need to save anything other than what's in a face
    bool                 savePrivateH9(std::ostream &,
                                       bool binary) const override;
    bool                 loadPrivateH9(UT_IStream &) override;

private:
    int                  create(int npts, int closed = 0, int appendPts = 1);

    friend std::ostream &operator<<(std::ostream &os, const GD_PrimPoly &d)
                        {
                            d.saveH9(os, 0,
                                     GD_Primitive::theEmptySaveAttribs,
                                     GD_Primitive::theEmptySaveAttribs);
                            return os;
                        }

    friend class GD_PrimitiveFactory;

    static GA_PrimitiveDefinition *theDefinition;
};
#endif