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

#ifndef __GT_PrimPointMesh__
#define __GT_PrimPointMesh__

#include "GT_API.h"

#include "GT_ElementSetMap.h"
#include "GT_Primitive.h"

/// @brief A mesh of unconnected points
class GT_API GT_PrimPointMesh : public GT_Primitive
{
public:
    GT_PrimPointMesh() {}
    GT_PrimPointMesh(const GT_AttributeListHandle &points,
                    const GT_AttributeListHandle &uniform)
    {
        init(points, uniform);
    }
    GT_PrimPointMesh(const GT_PrimPointMesh &src)
        : myPoints(src.myPoints)
        , myUniform(src.myUniform)
        , myPointSetMap(src.myPointSetMap)
        , GT_Primitive(src)
    {
    }
    ~GT_PrimPointMesh() override;

    const char *className() const override { return "GT_PrimPointMesh"; }
    bool        save(UT_JSONWriter &w) const override;
    
    /// - @c attribs
    ///   The length of this array determines the number of points.  There is
    ///   one entry per point.
    bool        init(const GT_AttributeListHandle &points,
                        const GT_AttributeListHandle &uniform)
                 {
                     myPoints = points;
                     myUniform = uniform;
                     return true;
                 }

    GT_Size                             getPointCount() const;
    SYS_DEPRECATED(12.5) GT_Size        getVertexCount() const
                                            { return getPointCount(); }

    /// Get the varying data array.  There is one entry for each vertex
    const GT_AttributeListHandle        &getPoints() const
                                            { return myPoints; }
    const GT_AttributeListHandle        &getUniform() const
                                            { return myUniform; }

    /// @{
    /// Access attributes
    const GT_AttributeListHandle        &getPointAttributes() const override
                                            { return myPoints; }
    // Uniforms are mapped to detail attributes for points, as they behave as
    // detail attributes to GL.
    const GT_AttributeListHandle        &getDetailAttributes() const override
                                            { return myUniform; }
    /// @}

    /// @{
    /// Access to the point sets
    const GT_ElementSetMapPtr   &pointSetMap() const { return myPointSetMap; }
    void                         setPointSetMap(const GT_ElementSetMapPtr &v)
                                        { myPointSetMap = v; }
    /// @}

    /// @{
    /// Methods defined on GT_Primitive
    void                enlargeBounds(UT_BoundingBox boxes[],
                                      int nsegment) const override;
    void                enlargeRenderBounds(UT_BoundingBox b[],
                                            int n) const override;
    int                 getPrimitiveType() const override;
    int                 getMotionSegments() const override;
    int64               getMemoryUsage() const override;
    /// @}

    /// Harden all attributes so there are no dangling dependencies
    GT_PrimitiveHandle  doHarden() const override;
    GT_PrimitiveHandle  doSoftCopy() const override
                            { return new GT_PrimPointMesh(*this); }

    /// The virtual implementation of attribute merging
    GT_PrimitiveHandle  doAttributeMerge(
                                const GT_Primitive &src,
                                const UT_StringMMPattern *vertex,
                                const UT_StringMMPattern *point,
                                const UT_StringMMPattern *uniform,
                                const UT_StringMMPattern *detail
                                ) const override;
private:
    GT_AttributeListHandle      myPoints;
    GT_AttributeListHandle      myUniform;
    GT_ElementSetMapPtr         myPointSetMap;
};

#endif