GU/GU_RandomPoint.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.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        GU_RandomPoint.h ( GU Library, C++)
 *
 * COMMENTS:    Create a cloud of points on a surface
 */

#ifndef __GU_RandomPoint__
#define __GU_RandomPoint__

#include "GU_API.h"
#include <SYS/SYS_Types.h>

class UT_FloatArray;
class GU_Detail;
class GB_PrimitiveGroup;

class GU_API GU_RandomPoint {
public:
    //!Random Point Generation
    //
    /// This method generates random points from the primitives in the detail.
    ///   gdp     - geometry containing the primitives (and which will contain
    ///             the points)
    ///   npoints - The number of points to generate
    ///   seed    - random number seed
    ///   probability - A probability array.  There should be one entry per
    ///             primitive which determines the probabilty of that primitive
    ///             having a point generated from it.
    ///   group   - Optionally, only generate from this group of primitives
    ///
    /// Points will be generated using as close to a uniform distribution as
    /// possible (in uv space on the primitives).  The point locations should
    /// remain constant based on primitive number, regardless of shearing or
    /// scaling.
    static void         generatePoints(GU_Detail &gdp, int npoints, uint seed,
                                     UT_FloatArray &probability,
                                     const GB_PrimitiveGroup *group);
};

#endif

---