Aerodynamic Objects Core 2.0.0
Loading...
Searching...
No Matches
AerodynamicObjects.Flow.AreaSource Class Reference

Provides flow velocity from either a circular or rectangular area. More...

Inheritance diagram for AerodynamicObjects.Flow.AreaSource:
AerodynamicObjects.FlowPrimitive

Public Types

enum  AreaShape
 

Public Member Functions

override Vector3 VelocityFunction (Vector3 position)
 Override this function to change the way the velocity of the fluid is calculated. More...
 
- Public Member Functions inherited from AerodynamicObjects.FlowPrimitive
void GetInteractionID ()
 Obtains a unique interaction ID for the object. More...
 
virtual void Awake ()
 
virtual void OnEnable ()
 
virtual void OnDestroy ()
 
virtual void OnDisable ()
 
void AddSelfToScene ()
 
void AcquireFluidVolume (FluidVolume fluidVolume)
 
void RemoveFromScene ()
 
Vector3 VelocityFunction (Vector3 position, int flowAffectedID)
 Wrapper function which first checks if the interaction should happen. More...
 
virtual Vector3 VelocityFunction (Vector3 position)
 Override this function to change the way the velocity of the fluid is calculated. More...
 
bool IsInteractionIgnored (int flowAffectedID)
 
void IgnoreInteraction (int flowAffectedID)
 
void IgnoreInteraction (FlowAffected flowAffected)
 
void AddSelfToGlobalFluid ()
 
void RemoveSelfFromGlobalFluid ()
 

Public Attributes

float speed = 1
 The flow speed at the source plane More...
 
AreaShape shape = AreaShape.Circle
 
float radius = 0.5f
 Used for circle only More...
 
float width = 0.5f
 Used for rectangle only More...
 
float height = 0.5f
 Used for rectangle only More...
 
Fade fade = Fade.DistanceLinear
 
- Public Attributes inherited from AerodynamicObjects.FlowPrimitive
float strengthScale = 1f
 This value is used to scale the flow primitive behaviour. More...
 
int interactionID = 0
 The unique ID number for this flow primitive, used for identifying pairs of ignored interactions by the FlowInteractionManager. More...
 

Detailed Description

Provides flow velocity from either a circular or rectangular area.

Member Enumeration Documentation

◆ AreaShape

Member Function Documentation

◆ VelocityFunction()

override Vector3 AerodynamicObjects.Flow.AreaSource.VelocityFunction ( Vector3  position)
virtual

Override this function to change the way the velocity of the fluid is calculated.

Parameters
positionPosition of the object in the global (earth) frame of reference.
Returns
The velocity of the fluid at the given position in the global (earth) frame.

Reimplemented from AerodynamicObjects.FlowPrimitive.

Member Data Documentation

◆ fade

Fade AerodynamicObjects.Flow.AreaSource.fade = Fade.DistanceLinear

◆ height

float AerodynamicObjects.Flow.AreaSource.height = 0.5f

Used for rectangle only

◆ radius

float AerodynamicObjects.Flow.AreaSource.radius = 0.5f

Used for circle only

◆ shape

AreaShape AerodynamicObjects.Flow.AreaSource.shape = AreaShape.Circle

◆ speed

float AerodynamicObjects.Flow.AreaSource.speed = 1

The flow speed at the source plane

◆ width

float AerodynamicObjects.Flow.AreaSource.width = 0.5f

Used for rectangle only


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