Public Member Functions | |
FlowChannel (FlowGeometry geometry) | |
Constructor. The channel contains no data, only the geometry which provides the grid is assigned. To change the data use the Data-field. | |
bool | HasTransfer () |
Checks if a transfer function has been assigned to this channel. | |
float | GetInterpolatedValue (Math.Vector3f pos) |
Returns the interpolated data at the specified position. The geometry object of the flow data is used to retrieve the indices of the four neighbouring grid cell indices. The result is the linear interpolation of the according values stored in this channel. If the position is outside of the grid the value 0 is returned. | |
float | GetNearestValue (Math.Vector3f pos) |
Returns the value of the nearest grid position. The nearest grid position is obtained by the geometry object. If the position is outside of the grid the value 0 is returned. | |
float | GetValueAtNormalizedPosition (Math.Vector3f normalizedPosition) |
Returns the interpolated value at a specified normalized position which means the position is given in the range of 0 to 1 in each direction. | |
float | NormalizeValue (float value) |
Normalized values are in the range from 0 to 1, where 0 corresponds to the minimum value of this channel and 1 to the maximum value of this channel. This method converts a denormalized value to a normalized one. | |
float | DenormalizeValue (float value) |
Normalized values are in the range from 0 to 1, where 0 corresponds to the minimum value of this channel and 1 to the maximum value of this channel. Denormalized values store the real value. This method converts a normalized value to a denormalized one. | |
Properties | |
float[] | Data [set] |
Gives access to the stored value. When the data is changed the minimum and maximum value are extracted. Throws an exception when new values are applied and the number of values doesn't fit to the geometry of this channel. | |
float | Maximum [get] |
Get the maximum value stored in this channel. | |
float | Minimum [get] |
Get the minimum value stored in this channel. | |
TransferFunction | Transfer [get, set] |
Set or get the transfer function assigned to this channel. |
FlowVis.Data.FlowChannel.FlowChannel | ( | FlowGeometry | geometry | ) |
Constructor. The channel contains no data, only the geometry which provides the grid is assigned. To change the data use the Data-field.
geometry | Geometry contains the grid for this flow data |
bool FlowVis.Data.FlowChannel.HasTransfer | ( | ) |
Checks if a transfer function has been assigned to this channel.
float FlowVis.Data.FlowChannel.GetInterpolatedValue | ( | Math.Vector3f | pos | ) |
Returns the interpolated data at the specified position. The geometry object of the flow data is used to retrieve the indices of the four neighbouring grid cell indices. The result is the linear interpolation of the according values stored in this channel. If the position is outside of the grid the value 0 is returned.
pos | Position from which the neighbouring grid cells are obtained |
float FlowVis.Data.FlowChannel.GetNearestValue | ( | Math.Vector3f | pos | ) |
Returns the value of the nearest grid position. The nearest grid position is obtained by the geometry object. If the position is outside of the grid the value 0 is returned.
pos | Position for which the nearest grid cell is obtained. |
float FlowVis.Data.FlowChannel.GetValueAtNormalizedPosition | ( | Math.Vector3f | normalizedPosition | ) |
Returns the interpolated value at a specified normalized position which means the position is given in the range of 0 to 1 in each direction.
normalizedPosition | normalizedPosition normalized position in the range of 0 to 1 |
float FlowVis.Data.FlowChannel.NormalizeValue | ( | float | value | ) |
Normalized values are in the range from 0 to 1, where 0 corresponds to the minimum value of this channel and 1 to the maximum value of this channel. This method converts a denormalized value to a normalized one.
value | denormalized value (which may have been retreived with one the GetValue-methods) |
float FlowVis.Data.FlowChannel.DenormalizeValue | ( | float | value | ) |
Normalized values are in the range from 0 to 1, where 0 corresponds to the minimum value of this channel and 1 to the maximum value of this channel. Denormalized values store the real value. This method converts a normalized value to a denormalized one.
value | normalized value in the range of 0 and 1 |
float [] FlowVis.Data.FlowChannel.Data [set] |
Gives access to the stored value. When the data is changed the minimum and maximum value are extracted. Throws an exception when new values are applied and the number of values doesn't fit to the geometry of this channel.
float FlowVis.Data.FlowChannel.Maximum [get] |
Get the maximum value stored in this channel.
float FlowVis.Data.FlowChannel.Minimum [get] |
Get the minimum value stored in this channel.
TransferFunction FlowVis.Data.FlowChannel.Transfer [get, set] |
Set or get the transfer function assigned to this channel.