GEO/GEO_PartRender.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:
 *      Mark Elendt
 *      Side Effects
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        GEO library (C++)
 *
 * COMMENTS:    Particle Render Options
 *
 */

#ifndef __GEO_PartRender_h__
#define __GEO_PartRender_h__

#include "GEO_API.h"
#include <iostream.h>
class UT_IStream;

/// Geometry type to use when rendering particles.
typedef enum {
    GEO_PARTICLE_SPHERE,                ///< Render as spheres
    GEO_PARTICLE_CIRCLE,                ///< Render as oriented circles
    GEO_PARTICLE_LINE,                  ///< Render as lines
    GEO_PARTICLE_TUBE,                  ///< Render as open tubes
    GEO_PARTICLE_TUBEC,                 ///< Render as capped tubes
    GEO_PARTICLE_TUBES                  ///< Render as rounded tubes
} GEO_PART_TYPE;

#define GEO_PART_MOTIONBLUR     0x0001  ///< Particles are motion blurred
#define GEO_PART_SPHERENML      0x0002  ///< Oriented circles use sphere normals
#define GEO_PART_VIRTUAL        0x0004  ///< Particles not to be rendered

/// A class to manage the various settings that control how a particle system
/// should be rendered.
class GEO_API GEO_PartRender {
public:
     GEO_PartRender();
    ~GEO_PartRender();

    int                 save(ostream &os, int binary) const;
    bool                load(UT_IStream &is);

    void                setSize(float radius)   { mySize = radius; }
    void                setBlurTime(float bt)   { myBlurTime = bt; }
    void                setType(GEO_PART_TYPE t){ myType = t; }
    void                setMotionBlur(int onOff)
                        {
                            if (onOff)  myFlag |=  GEO_PART_MOTIONBLUR;
                            else        myFlag &= ~GEO_PART_MOTIONBLUR;
                        }
    void                setSphereNormals(int onOff)
                        {
                            if (onOff)  myFlag |=  GEO_PART_SPHERENML;
                            else        myFlag &= ~GEO_PART_SPHERENML;
                        }
    void                setVirtual(int onOff)
                        {
                            if (onOff)  myFlag |=  GEO_PART_VIRTUAL;
                            else        myFlag &= ~GEO_PART_VIRTUAL;
                        }


    float               getSize() const         { return mySize; }
    float               getBlurTime() const     { return myBlurTime; }
    GEO_PART_TYPE       getType() const         { return myType; }
    int                 isMotionBlur()  const
                        { return myFlag & GEO_PART_MOTIONBLUR; }
    int                 isSphereNormal() const
                        { return myFlag & GEO_PART_SPHERENML; }
    int                 isVirtual() const
                        { return myFlag & GEO_PART_VIRTUAL; }

private:
    int                 myFlag;
    float               mySize;
    float               myBlurTime;
    GEO_PART_TYPE       myType;
};

#endif

---