Barotrauma Client Doc
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | List of all members
Barotrauma.SpriteDeformations.SpriteDeformation Class Referenceabstract
Inheritance diagram for Barotrauma.SpriteDeformations.SpriteDeformation:
Barotrauma.SpriteDeformations.CustomDeformation Barotrauma.SpriteDeformations.Inflate Barotrauma.SpriteDeformations.JointBendDeformation Barotrauma.SpriteDeformations.NoiseDeformation Barotrauma.SpriteDeformations.PositionalDeformation

Public Types

enum class  DeformationBlendMode { Add , Multiply , Override }
 

Public Member Functions

void SetResolution (Point resolution)
 
abstract void Update (float deltaTime)
 
virtual void Save (XElement element)
 

Static Public Member Functions

static SpriteDeformation Load (string deformationType, string parentDebugName)
 
static SpriteDeformation Load (XElement element, string parentDebugName)
 
static Vector2[,] GetDeformation (IEnumerable< SpriteDeformation > animations, Vector2 scale, bool inverseY=false)
 

Protected Member Functions

 SpriteDeformation (XElement element, SpriteDeformationParams deformationParams)
 
abstract void GetDeformation (out Vector2[,] deformation, out float multiplier, bool inverse)
 

Properties

virtual float Phase [get, set]
 
Vector2[,] Deformation [get]
 
SpriteDeformationParams Params [get, set]
 
static IEnumerable< string > DeformationTypes [get]
 
Point Resolution [get, set]
 
string TypeName [get]
 
int Sync [get]
 

Detailed Description

Definition at line 96 of file SpriteDeformation.cs.

Member Enumeration Documentation

◆ DeformationBlendMode

enum Barotrauma.SpriteDeformations.SpriteDeformation.DeformationBlendMode
strong
Enumerator
Add 
Multiply 
Override 

Definition at line 98 of file SpriteDeformation.cs.

Constructor & Destructor Documentation

◆ SpriteDeformation()

Barotrauma.SpriteDeformations.SpriteDeformation.SpriteDeformation ( XElement  element,
SpriteDeformationParams  deformationParams 
)
protected

Definition at line 185 of file SpriteDeformation.cs.

Member Function Documentation

◆ GetDeformation() [1/2]

static Vector2 [,] Barotrauma.SpriteDeformations.SpriteDeformation.GetDeformation ( IEnumerable< SpriteDeformation >  animations,
Vector2  scale,
bool  inverseY = false 
)
static

Definition at line 203 of file SpriteDeformation.cs.

◆ GetDeformation() [2/2]

abstract void Barotrauma.SpriteDeformations.SpriteDeformation.GetDeformation ( out Vector2  deformation[,],
out float  multiplier,
bool  inverse 
)
protectedpure virtual

Implemented in Barotrauma.SpriteDeformations.PositionalDeformation, Barotrauma.SpriteDeformations.NoiseDeformation, Barotrauma.SpriteDeformations.JointBendDeformation, Barotrauma.SpriteDeformations.Inflate, and Barotrauma.SpriteDeformations.CustomDeformation.

◆ Load() [1/2]

static SpriteDeformation Barotrauma.SpriteDeformations.SpriteDeformation.Load ( string  deformationType,
string  parentDebugName 
)
static

Definition at line 127 of file SpriteDeformation.cs.

◆ Load() [2/2]

static SpriteDeformation Barotrauma.SpriteDeformations.SpriteDeformation.Load ( XElement  element,
string  parentDebugName 
)
static

Definition at line 131 of file SpriteDeformation.cs.

◆ Save()

virtual void Barotrauma.SpriteDeformations.SpriteDeformation.Save ( XElement  element)
virtual

Reimplemented in Barotrauma.SpriteDeformations.CustomDeformation.

Definition at line 257 of file SpriteDeformation.cs.

◆ SetResolution()

void Barotrauma.SpriteDeformations.SpriteDeformation.SetResolution ( Point  resolution)

Definition at line 192 of file SpriteDeformation.cs.

◆ Update()

abstract void Barotrauma.SpriteDeformations.SpriteDeformation.Update ( float  deltaTime)
pure virtual

Implemented in Barotrauma.SpriteDeformations.PositionalDeformation, Barotrauma.SpriteDeformations.NoiseDeformation, Barotrauma.SpriteDeformations.JointBendDeformation, Barotrauma.SpriteDeformations.Inflate, and Barotrauma.SpriteDeformations.CustomDeformation.

Property Documentation

◆ Deformation

Vector2 [,] Barotrauma.SpriteDeformations.SpriteDeformation.Deformation
getprotected

Definition at line 107 of file SpriteDeformation.cs.

◆ DeformationTypes

IEnumerable<string> Barotrauma.SpriteDeformations.SpriteDeformation.DeformationTypes
staticget

Definition at line 112 of file SpriteDeformation.cs.

◆ Params

SpriteDeformationParams Barotrauma.SpriteDeformations.SpriteDeformation.Params
getset

Definition at line 109 of file SpriteDeformation.cs.

◆ Phase

virtual float Barotrauma.SpriteDeformations.SpriteDeformation.Phase
getset

Definition at line 105 of file SpriteDeformation.cs.

◆ Resolution

Point Barotrauma.SpriteDeformations.SpriteDeformation.Resolution
getset

Definition at line 117 of file SpriteDeformation.cs.

◆ Sync

int Barotrauma.SpriteDeformations.SpriteDeformation.Sync
get

Definition at line 125 of file SpriteDeformation.cs.

◆ TypeName

string Barotrauma.SpriteDeformations.SpriteDeformation.TypeName
get

Definition at line 123 of file SpriteDeformation.cs.