[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

A3DL::Snow Class Reference
[libmetaobject_a3dl]

#include <vos/metaobjects/a3dl/snow.hh>

Inheritance diagram for A3DL::Snow:

List of all members.

---

Detailed Description

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 might be used, possibly tinted with that color.

Definition at line 52 of file snow.hh.

Public Member Functions

• Snow (VOS::VobjectBase *superobject)

  Constructor.
  

• virtual ~Snow ()

  Destructor.
  

• virtual const std::string getVOSType ()

  Return type std::string ("a3dl:object3D.snow").
  

Access Subobjects

• virtual int getParticleDensity ()

  Get the value of a3dl:particle-density property (Number of "snowflakes" per square unit of space.
  

• virtual void setParticleDensity (int value)

  Set a3dl:particle-density property.
  

• virtual VUtil::vRef< VOS::Property > getParticleDensityObject ()

  Get the a3dl:particle-density object.
  

• virtual void setParticleDensityObject (VOS::Property *newobj)

  Set the a3dl:particle-density object.
  

• virtual void getParticleSize (double &x, double &y)

  Get the values in the a3dl:particle-size property.
  

• virtual void setParticleSize (double x, double y)

  Set a3dl:particle-size property.
  

• virtual VUtil::vRef< VOS::Property > getParticleSizeObject ()

  Get the a3dl:particle-size object.
  

• virtual void setParticleSizeObject (VOS::Property *newobj)

  Set the a3dl:particle-size object.
  

• virtual double getFallingSpeed ()

  Get the value of a3dl:falling-speed property.
  

• virtual void setFallingSpeed (double value)

  Set a3dl:falling-speed property.
  

• virtual VUtil::vRef< VOS::Property > getFallingSpeedObject ()

  Get the a3dl:falling-speed object.
  

• virtual void setFallingSpeedObject (VOS::Property *newobj)

  Set the a3dl:falling-speed object.
  

• virtual double getSwirliness ()

  Get the value of a3dl:swirliness property.
  

• virtual void setSwirliness (double value)

  Set a3dl:swirliness property.
  

• virtual VUtil::vRef< VOS::Property > getSwirlinessObject ()

  Get the a3dl:swirliness object.
  

• virtual void setSwirlinessObject (VOS::Property *newobj)

  Set the a3dl:swirliness object.
  

Static Public Member Functions

• static VOS::MetaObject * new_Snow (VOS::VobjectBase *s, const std::string &t)

---

Constructor & Destructor Documentation

A3DL::Snow::Snow

(

VOS::VobjectBase *

superobject

)

Constructor.

virtual A3DL::Snow::~Snow

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual double A3DL::Snow::getFallingSpeed

(

)

[virtual]

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 VUtil::vRef<VOS::Property> A3DL::Snow::getFallingSpeedObject

(

)

[virtual]

Get the a3dl:falling-speed object.

virtual int A3DL::Snow::getParticleDensity

(

)

[virtual]

Get the value of a3dl:particle-density property (Number of "snowflakes" per square unit of space.

virtual VUtil::vRef<VOS::Property> A3DL::Snow::getParticleDensityObject

(

)

[virtual]

Get the a3dl:particle-density object.

virtual void A3DL::Snow::getParticleSize	(	double &	x,
		double &	y
	)			[virtual]

Get the values in the a3dl:particle-size property.

Parameters:

	x	replaced with the width of each "snowflake"
	y	replaced with the height of each "snowflake"

virtual VUtil::vRef<VOS::Property> A3DL::Snow::getParticleSizeObject

(

)

[virtual]

Get the a3dl:particle-size object.

virtual double A3DL::Snow::getSwirliness

(

)

[virtual]

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 VUtil::vRef<VOS::Property> A3DL::Snow::getSwirlinessObject

(

)

[virtual]

Get the a3dl:swirliness object.

virtual const std::string A3DL::Snow::getVOSType

(

)

[virtual]

Return type std::string ("a3dl:object3D.snow").

Reimplemented from A3DL::Object3D.

static VOS::MetaObject* A3DL::Snow::new_Snow	(	VOS::VobjectBase *	s,
		const std::string &	t
	)			[static]

virtual void A3DL::Snow::setFallingSpeed

(

double

value

)

[virtual]

Set a3dl:falling-speed property.

Parameters:

value

The new value

virtual void A3DL::Snow::setFallingSpeedObject

(

VOS::Property *

newobj

)

[virtual]

Set the a3dl:falling-speed object.

Parameters:

newobj

The new subobject.

virtual void A3DL::Snow::setParticleDensity

(

int

value

)

[virtual]

Set a3dl:particle-density property.

Parameters:

value

The new value

virtual void A3DL::Snow::setParticleDensityObject

(

VOS::Property *

newobj

)

[virtual]

Set the a3dl:particle-density object.

Parameters:

newobj

The new subobject.

virtual void A3DL::Snow::setParticleSize	(	double	x,
		double	y
	)			[virtual]

Set a3dl:particle-size property.

Parameters:

	x	The new width.
	y	The new height.

virtual void A3DL::Snow::setParticleSizeObject

(

VOS::Property *

newobj

)

[virtual]

Set the a3dl:particle-size object.

Parameters:

newobj

The new subobject.

virtual void A3DL::Snow::setSwirliness

(

double

value

)

[virtual]

Set a3dl:swirliness property.

Parameters:

value

The new value. Should be between 0 and 1; values outside this range will be adjusted to either 0 or 1.

virtual void A3DL::Snow::setSwirlinessObject

(

VOS::Property *

newobj

)

[virtual]

Set the a3dl:swirliness object.

Parameters:

newobj

The new subobject.

---

The documentation for this class was generated from the following file:

• /home/tetron/hack/vos/libs/vos/metaobjects/a3dl/snow.hh