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

#ifndef __GEO_PrimNull__
#define __GEO_PrimNull__

#include "GEO_API.h"
#include "GEO_Primitive.h"
#include <GA/GA_Types.h>
#include <UT/UT_Assert.h>
#include <UT/UT_Vector3.h>

class GA_Detail;
class GEO_ConvertParms;

/// Null primitive is a stand-in primitive to handle loading of unknown
/// primitives
class GEO_API GEO_PrimNull : public GEO_Primitive
{
protected:
    /// NOTE: The destructor should only be called from subclass
    ///       destructors.
    ~GEO_PrimNull() override {}

public:
    /// NOTE: The constructor should only be called from subclass
    ///       constructors.
    GEO_PrimNull(GA_Detail *d, GA_Offset offset=GA_INVALID_OFFSET)
        : GEO_Primitive(d, offset)
    {}

    /// @{
    /// Required interface for GEO
    bool                    isDegenerate() const override { return true; }
    bool                    getBBox(UT_BoundingBox *bbox) const override;
    void                    reverse() override {}
    UT_Vector3D             computeNormalD() const override;
    UT_Vector3              computeNormal() const override;
    void                    copyPrimitive(const GEO_Primitive *s) override;
    int                     detachPoints(GA_PointGroup &g) override;
    GA_DereferenceStatus    dereferencePoint(GA_Offset, bool) override;
    GA_DereferenceStatus    dereferencePoints(
                                    const GA_RangeMemberQuery &, bool) override;
    const GA_PrimitiveJSON *getJSON() const override;
    bool                    evaluatePointRefMap(
                                    GA_Offset,
                                    GA_AttributeRefMap &,
                                    fpreal, fpreal, uint, uint) const override;
    /// @}

    /// @{
    /// Special for factory primitives
    static GA_PrimitiveFamilyMask   buildFamilyMask()
                                        { return GA_FAMILY_NONE; }
    /// @}

    /// Report approximate memory usage.
    int64                   getMemoryUsage() const override
                                { return sizeof(*this); }

    /// 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;

    /// @{
    /// Minimal interface required by GU
    const GA_PrimitiveDefinition    &getTypeDef() const override
                                    {
                                        UT_ASSERT(theDefinition);
                                        return *theDefinition;
                                    }

    GEO_Primitive          *convert(GEO_ConvertParms &,
                                    GA_PointGroup *) override
                                { return NULL; }
    GEO_Primitive          *convertNew(GEO_ConvertParms &) override
                                { return NULL; }

    void                    normal(NormalComp &) const override {}
    void                    normal(NormalCompD &) const override {}
    int                     intersectRay(
                                    const UT_Vector3 &,
                                    const UT_Vector3 &,
                                    float, float,
                                    float *, UT_Vector3 *,
                                    UT_Vector3 *, int,
                                    float *, float *,
                                    int) const override
                                { return 0; }
    /// @}

private:
    static GA_PrimitiveDefinition *theDefinition;
    friend class GU_PrimitiveFactory;
};

#endif