Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
pluginbase.Helpers.Computative.Combiners.ScalarValue Class Reference

Class that represents a scalar value for the combiner engine Easier than writing more operators More...

Inheritance diagram for pluginbase.Helpers.Computative.Combiners.ScalarValue:
pluginbase.Helpers.Computative.ValuePoint3D

Public Member Functions

 ScalarValue (float v)
 Initializes a new instance of the pluginbase.Helpers.Computative.Combiners.ScalarValue class. More...
 
override float GetValue (int x, int y, int z)
 We're always the same More...
 
override float GetValue (int x, int y)
 Gets the value. More...
 
override string ToString ()
 Gets a human-readable string representing a scalar value More...
 
- Public Member Functions inherited from pluginbase.Helpers.Computative.ValuePoint3D
ValuePoint3D Mix (ValuePoint3D with, float sourceOpacity)
 Mix this value with another one at a certain ratio More...
 
ValuePoint3D Lighten (ValuePoint3D with)
 Lighten this value by another one More...
 
ValuePoint3D Darken (ValuePoint3D with)
 Darken this value by another one More...
 
ValuePoint3D CustomCombine (ValuePoint3D with, Combiner3D.CombinerOperator func)
 Combine two values using a custom combiner More...
 
ValuePoint3D CustomManipulator (Manip3D.ManipOperator func)
 Manipulate this value with a custom manipulator More...
 
ValuePoint3D Abs ()
 Absolute value More...
 
ValuePoint3D Invert ()
 Invert the value from a 0-1 range More...
 
ValuePoint3D Brightness (float amount)
 Adjust brightness. Takes in -1 to 1f More...
 
ValuePoint3D Contrast (float amount)
 Adjusts contract from -1 to 1 More...
 
ValuePoint3D Scale (float factor)
 Scale the specified factor and clamp More...
 
ValuePoint3D LinearBounds (float min, float max)
 Linearly interpolates to squish between the bounds More...
 
ValuePoint3D Threshold (float threshold)
 Threshold the specified threshold. Returns 0 if below, otherwise 1f More...
 
ValuePoint3D Gamma (float gamma)
 Gamma the specified gamma. Range 0f - 2f More...
 
ValuePoint3D Clamp ()
 Clamp this value between 0 and 1 More...
 
ValuePoint3D Clamp (float min, float max)
 Clamp this value between a min and max More...
 

Static Public Member Functions

static implicit operator ScalarValue (float v)
 Cast the a float to a scalar value More...
 
static implicit operator float (ScalarValue v)
 Cast a scalar value back to a float More...
 
- Static Public Member Functions inherited from pluginbase.Helpers.Computative.ValuePoint3D
static ValuePoint3D operator+ (ValuePoint3D a, ValuePoint3D b)
 Add two value points together More...
 
static ValuePoint3D operator- (ValuePoint3D a, ValuePoint3D b)
 Subtract two value points More...
 
static ValuePoint3D operator* (ValuePoint3D a, ValuePoint3D b)
 Multiply two value points More...
 
static ValuePoint3D operator/ (ValuePoint3D a, ValuePoint3D b)
 Divide one value by another More...
 

Detailed Description

Class that represents a scalar value for the combiner engine Easier than writing more operators

Constructor & Destructor Documentation

pluginbase.Helpers.Computative.Combiners.ScalarValue.ScalarValue ( float  v)

Initializes a new instance of the pluginbase.Helpers.Computative.Combiners.ScalarValue class.

Parameters
vV.
17  {
18  val = v;
19  }

Member Function Documentation

override float pluginbase.Helpers.Computative.Combiners.ScalarValue.GetValue ( int  x,
int  y,
int  z 
)
virtual

We're always the same

Parameters
xA System.Int32
yA System.Int32
zA System.Int32
Returns
A System.Single

Implements pluginbase.Helpers.Computative.ValuePoint3D.

37  {
38  return val;
39  }
override float pluginbase.Helpers.Computative.Combiners.ScalarValue.GetValue ( int  x,
int  y 
)
virtual

Gets the value.

Returns
The value.
Parameters
xThe x coordinate.
yThe y coordinate.

Implements pluginbase.Helpers.Computative.ValuePoint3D.

48  {
49  return val;
50  }
static implicit pluginbase.Helpers.Computative.Combiners.ScalarValue.operator float ( ScalarValue  v)
static

Cast a scalar value back to a float

66  {
67  return v.val;
68  }
static implicit pluginbase.Helpers.Computative.Combiners.ScalarValue.operator ScalarValue ( float  v)
static

Cast the a float to a scalar value

58  {
59  return new ScalarValue(v);
60  }
ScalarValue(float v)
Initializes a new instance of the pluginbase.Helpers.Computative.Combiners.ScalarValue class...
Definition: ScalarValue.cs:16
override string pluginbase.Helpers.Computative.Combiners.ScalarValue.ToString ( )

Gets a human-readable string representing a scalar value

Returns
A System.String that represents the current pluginbase.Helpers.Computative.Combiners.ScalarValue.
75  {
76  return string.Format("[ScalarValue {0}]", val);
77  }

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