vos/3D/a3dl/snow.hh

Go to the documentation of this file.

/* $Id: snow.hh,v 1.6 2003/07/24 05:18:54 tetron Exp $ */


/* This file was generated by otd2cpp.pl, a script for VOS by Reed Hedges
  <reed@zerohour.net> and Peter Amstutz <tetron@interreality.org>

    Copyright (C) 2002 Reed Hedges <reed@interreality.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA

 */

#ifndef _A3DL_SNOW_HH_
#define _A3DL_SNOW_HH_


#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>

#include <vos/3D/a3dl/object3d.hh>

#if defined(_WIN32) && defined(_MSC_VER)
# ifdef A3DL_EXPORTS
#  define A3DL_API __declspec(dllexport)
# else
#  define A3DL_API __declspec(dllimport)
# endif
#else
# define A3DL_API
#endif

/** MetaObject implementing Snow Object Type.

        This object represents a region of snow-like precipitation. The scaling
        property represents the extents of the region (a box), and the orientation
        represents the direction from which the precipitation falls (i.e., "0 1 0 0" is
        normal, downward-falling snow.)  The material property should contain an image
        used for each "snowflake." If it is not an image, then some default
        image will be used, possibly tinted with that color.

*/

namespace A3DL {

class A3DL_API Snow : public virtual Object3D {

protected:
    PropertyAccessControl* accessControl;


public:

    /** Constructor */
    Snow(MetaObject* superobject);

    /** Destructor */
    virtual ~Snow();

    /** Return type string ("a3dl:object3D.MATERIALINFO.object3D.snow") */
    virtual const string getType();

    /** Register Extenders */
    static void registerExtenders();

    static MetaObject* new_Snow(MetaObject* s, const string& t);

    /** Set default access control policy */
    virtual void setPropertyAccessControl(PropertyAccessControl* ac);

    /** Get default access control policy */
    virtual PropertyAccessControl* getPropertyAccessControl();

    /** @name Access Subobjects */
    //@{

    /** Get the value of a3dl:particle-density property (Number of "snowflakes" per square unit of space.
     */
    virtual int getParticleDensity();

    /** Set a3dl:particle-density property.
        @param value The new value
        @param ac Property access control policy. If omitted, then &NoAccessControl::static_ will be used.
    */
    virtual void setParticleDensity(int value, PropertyAccessControl* ac = NULL);

    /** Get the a3dl:particle-density object. */
    virtual Property* getParticleDensityObject();

    /** Set the a3dl:particle-density object.
        @param newobj   The new subobject. */
    virtual void setParticleDensityObject(Property* newobj);

    /** Get the values in the a3dl:particle-size property
        @param x replaced with the width of each "snowflake"
        @param y replaced with the height of each "snowflake"
    */
    virtual void getParticleSize(double& x, double& y);

    /** Set a3dl:particle-size property.
        @param x The new width.
        @param y The new height.
        @param ac Property access control policy. If omitted, then &NoAccessControl::static_ will be used.
    */
    virtual void setParticleSize(double x, double y, PropertyAccessControl* ac = NULL);

    /** Get the a3dl:particle-size object. */
    virtual Property* getParticleSizeObject();

    /** Set the a3dl:particle-size object.
        @param newobj   The new subobject. */
    virtual void setParticleSizeObject(Property* newobj);

    /** Get the value of a3dl:falling-speed property.
            This is the general rate of falling of snow from direction given in orientation,
            units/sec. Actual speed vary to create more snowlike effect.
      */
    virtual double getFallingSpeed();

    /** Set a3dl:falling-speed property.
        @param value The new value
        @param ac Property access control policy. If omitted, then &NoAccessControl::static_ will be used.
    */
    virtual void setFallingSpeed(double value, PropertyAccessControl* ac = NULL);

    /** Get the a3dl:falling-speed object. */
    virtual Property* getFallingSpeedObject();

    /** Set the a3dl:falling-speed object.
        @param newobj   The new subobject. */
    virtual void setFallingSpeedObject(Property* newobj);

    /** Get the value of a3dl:swirliness property.
        This value represents the probability that "snowflakes" will change
direction as they fall. It will range from 0 to 1.
      */
    virtual double getSwirliness();

    /** Set a3dl:swirliness property.
        @param value The new value. Should be between 0 and 1; values outside
this range will be adjusted to either 0 or 1.
        @param ac Property access control policy. If omitted, then &NoAccessControl::static_ will be used.
    */
    virtual void setSwirliness(double value, PropertyAccessControl* ac = NULL);

    /** Get the a3dl:swirliness object. */
    virtual Property* getSwirlinessObject();

    /** Set the a3dl:swirliness object.
        @param newobj   The new subobject. */
    virtual void setSwirlinessObject(Property* newobj);

    //@}


};

} // namespace

#endif // #ifndef _A3DL_SNOW_HH_

---