ForestWindEmitter
Engine/source/forest/forestWindEmitter.h
Protected Types
_Anonymous_ { EnabledMask = Parent::NextFreeMask << 0 WindMask = Parent::NextFreeMask << 1 NextFreeMask = Parent::NextFreeMask << 2 }
Private Types
Parent
Public Friends
class
class
Protected Attributes
bool
bool
bool
bool
An object that the emitter can get position updates from.
bool
Explicitly denotes whether this is a global directional wind emitter or a localized radial wind emitter.
Controls how often the wind gust peaks per second.
The maximum distance in meters that the peak wind gust will displace an element.
The maximum amount of random wobble that will be applied to the gusting as well as the yaw rotation.
The range that the wind direction will yaw between (-val to +val).
The frequency, in seconds, between animations in the gust yaw angle.
If the radius is greater than zero then this is a localized radial wind emitter.
Controls the overally rapidity of the wind turbulence.
The maximum distance in meters that the turbulence can displace a ground cover element.
Protected Static Attributes
Protected Functions
_onMountObjectGhostReceived(SceneObject * object)
Public Functions
ForestWindEmitter(bool makeClientObject)
_renderEmitterInfo(ObjectRenderInst * ri, SceneRenderState * state, BaseMatInstance * overrideMat)
attachToObject(SceneObject * obj)
getWind()
Called after any property of the object is changed in the world editor.
bool
bool
bool
bool
onAdd()
Called when the object is added to the sim.
onDeleteNotify(SimObject * object)
Called when a SimObject is deleted.
Called when the editor is deactivated.
Called when the editor is activated.
packUpdate(NetConnection * conn, U32 mask, BitStream * stream)
Instructs this object to pack its state for transfer over the network.
prepRenderImage(SceneRenderState * state)
Called when the SceneManager is ready for the registration of render instances.
setStrength(F32 strength)
setTransform(const MatrixF & mat)
Sets the Object -> World transform.
setWindRadius(F32 radius)
unpackUpdate(NetConnection * conn, BitStream * stream)
Instructs this object to read state data previously packed with packUpdate.
Public Static Functions
Detailed Description
Protected Types
@82
Enumerator
- EnabledMask = Parent::NextFreeMask << 0
- WindMask = Parent::NextFreeMask << 1
- NextFreeMask = Parent::NextFreeMask << 2
Private Types
typedef SceneObject Parent
Public Friends
Protected Attributes
bool mAddedToScene
bool mEnabled
bool mHasMount
bool mIsMounted
SimObjectPtr< SceneObject > mMountObject
An object that the emitter can get position updates from.
bool mRadialEmitter
Explicitly denotes whether this is a global directional wind emitter or a localized radial wind emitter.
ForestWind * mWind
VectorF mWindDirection
F32 mWindGustFrequency
Controls how often the wind gust peaks per second.
F32 mWindGustStrength
The maximum distance in meters that the peak wind gust will displace an element.
F32 mWindGustWobbleStrength
The maximum amount of random wobble that will be applied to the gusting as well as the yaw rotation.
F32 mWindGustYawAngle
The range that the wind direction will yaw between (-val to +val).
F32 mWindGustYawFrequency
The frequency, in seconds, between animations in the gust yaw angle.
F32 mWindRadius
If the radius is greater than zero then this is a localized radial wind emitter.
F32 mWindStrength
F32 mWindTurbulenceFrequency
Controls the overally rapidity of the wind turbulence.
F32 mWindTurbulenceStrength
The maximum distance in meters that the turbulence can displace a ground cover element.
Protected Static Attributes
ForestWindEmitterList smEmitters
Protected Functions
_initWind(U32 mask)
_onMountObjectGhostReceived(SceneObject * object)
Public Functions
ForestWindEmitter(bool makeClientObject)
~ForestWindEmitter()
_renderEmitterInfo(ObjectRenderInst * ri, SceneRenderState * state, BaseMatInstance * overrideMat)
attachToObject(SceneObject * obj)
DECLARE_CONOBJECT(ForestWindEmitter )
getStrength()
getWind()
getWindRadius()
getWindRadiusSquared()
inspectPostApply()
Reimplemented from: SceneObject
isEnabled()
isLocalWind()
isRadialEmitter()
onAdd()
Reimplemented from: SceneObject
onDeleteNotify(SimObject * object)
Reimplemented from: SceneObject
onEditorDisable()
Reimplemented from: SimObject
onEditorEnable()
Reimplemented from: SimObject
onRemove()
Reimplemented from: SceneObject
packUpdate(NetConnection * conn, U32 mask, BitStream * stream)
Reimplemented from: SceneObject
prepRenderImage(SceneRenderState * state)
Reimplemented from: SceneObject
setStrength(F32 strength)
setTransform(const MatrixF & mat)
Reimplemented from: SceneObject
setWindRadius(F32 radius)
unpackUpdate(NetConnection * conn, BitStream * stream)
Reimplemented from: SceneObject
updateMountPosition()