GU_PrimPlane.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_PrimPlane.h (C++)
 *
 * COMMENTS:
 *      Header file for GU_PrimPlane class.
 */

#ifndef __GU_PrimPlane_h__
#define __GU_PrimPlane_h__

#include "GU_API.h"
#include "GU_Detail.h"
#include <GEO/GEO_PrimPlane.h>
#include <UT/UT_Matrix4.h>

class GA_ElementWranglerCache;
class GA_PointGroup;
class GEO_ConvertParms;
class UT_MemoryCounter;

class GU_API GU_PrimPlaneParms
{
public:
    GU_PrimPlaneParms(GU_Detail *gdp = NULL, GA_Offset ptoff = GA_INVALID_OFFSET);

    GU_Detail          *gdp;
    GA_Offset           ptoff;          // use this point instead of yours
    UT_Matrix4          xform;
};

class GU_API GU_PrimPlane : public GEO_PrimPlane
{
protected:
    /// NOTE: Primitives should not be deleted directly.  They are managed
    ///       by the GA_PrimitiveList and the stash.
    ~GU_PrimPlane() override {}

public:
    /// NOTE: This constructor should only be called via GU_PrimitiveFactory.
    GU_PrimPlane(GU_Detail *gdp, GA_Offset offset = GA_INVALID_OFFSET)
        : GEO_PrimPlane(gdp, offset)
    {}

    /// Report approximate 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_PrimitiveDefinition &getTypeDef() const override
    {
        UT_ASSERT(theDefinition);
        return *theDefinition;
    }

    // Conversion Methods
    GEO_Primitive       *convert(GEO_ConvertParms &parms,
                                 GA_PointGroup *usedpts = 0) override;
    GEO_Primitive       *convertNew(GEO_ConvertParms &parms) override;

    void                normal(NormalComp &output) const override;
    void                normal(NormalCompD &output) const override;

    static GEO_Primitive        *build(const GU_PrimPlaneParms &parms,
                                       GA_PrimitiveTypeId type = GEO_PRIMPLANE);

    int                 intersectRay(const UT_Vector3 &o,
                                     const UT_Vector3 &d,
                                     float tmax = 1E17F, float tol = 1E-12F,
                                     float *distance = 0,
                                     UT_Vector3 *pos = 0,
                                     UT_Vector3 *nml = 0,
                                     int accurate = 0,
                                     float *u = 0, float *v = 0,
                                     int ignoretrim = 1) const override;

private:
    static GA_PrimitiveDefinition   *theDefinition;
    friend class                    GU_PrimitiveFactory;
SYS_DEPRECATED_PUSH_DISABLE()
};
SYS_DEPRECATED_POP_DISABLE()

#endif