GR_ShapeFactory.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:        GR_ShapeFactory ( GR Library, C++)
 *
 * COMMENTS:
 *      Generates basic shapes in the form of RE_Geometry objects.
 *      Wireframe versions are connectivity group RE_GEO_WIRE_IDX.
 *      Shaded versions (if applicable) are in RE_GEO_SHADED_IDX.
 */
#ifndef GR_ShapeFactory_h
#define GR_ShapeFactory_h

#include "GR_API.h"
#include <UT/UT_UniquePtr.h>
#include <UT/UT_VectorTypes.h>
#include <RE/RE_RenderContext.h>

class RE_RenderContext;
class RV_Geometry;

namespace GR_ShapeFactory
{

enum Orientation
{
    ORIENT_XY,
    ORIENT_XZ,
    ORIENT_YZ
};

GR_API extern bool buildGrid(RE_RenderContext r,
                             UT_Vector2F size,
                             UT_UniquePtr<RV_Geometry> &out_geo);

GR_API extern bool buildBox(RE_RenderContext r,
                            UT_Vector3F center,
                            UT_Vector3F size,
                            UT_UniquePtr<RV_Geometry> &out_geo);

GR_API extern bool buildLine(RE_RenderContext r,
                             UT_Vector3F p0,
                             UT_Vector3F p1,
                             UT_UniquePtr<RV_Geometry> &out_geo);

GR_API extern bool buildCircle(RE_RenderContext r,
                               UT_Vector3F center,
                               UT_Vector2F radius,
                               Orientation orient,
                               UT_UniquePtr<RV_Geometry> &out_geo);

GR_API extern bool buildCylinder(RE_RenderContext r,
                                 UT_Vector3F center,
                                 UT_Vector2F radius,
                                 fpreal length,
                                 Orientation orient,
                                 UT_UniquePtr<RV_Geometry> &out_geo);

GR_API extern bool buildSphere(RE_RenderContext r,
                               UT_Vector3F center,
                               UT_Vector3F radius,
                               UT_UniquePtr<RV_Geometry> &geo);

// simple bone
GR_API extern bool buildBone(RE_RenderContext r,
                             UT_UniquePtr<RV_Geometry> &out_geo);

GR_API extern bool buildSolverBone(RE_RenderContext r,
                             UT_UniquePtr<RV_Geometry> &out_geo);
}

#endif