Usine SDK  HH3-7.01.001
Create user modules for Usine Software
Global functions

Mandatory Functions

Usine need them to instantiate and destroy the module.

void CreateModule (void *&pModule, AnsiCharPtr optionalString, LongBool Flag, MasterInfo *pMasterInfo, AnsiCharPtr optionalContent)
 Called by Usine to instantiate the User Module When opening the Browser section where is stored the module. More...
 
void DestroyModule (void *pModule)
 Called by Usine to destroy the User Module When clearing a workspace or patch. More...
 
void GetBrowserInfo (ModuleInfo *pModuleInfo)
 Called by usine to get module informations for the browser When the browser open the folder where the module is stored. More...
 

Color Helpers

Various helpers around colors.

TColorAhsl sdkColorArgbToColorAhsl (TColorArgb c1)
 
TColorArgb sdkColorAhslToColorArgb (TColorAhsl c1)
 
TColorUsine sdkColorArgbToAlphaColor (TColorArgb c1)
 
TColorArgb sdkAlphaColorToColorArgb (TColorUsine c1)
 
TColorUsine sdkColorAhslToAlphaColor (TColorAhsl c1)
 
TColorAhsl sdkAlphaColorToColorAhsl (TColorUsine c1)
 
TColorArgb sdkColorAgrb (float r, float g, float b, float a=1.0)
 
TColorAhsl sdkColorAhsl (float h, float s, float l, float a=1.0)
 
TColorUsine sdkAlphaColor (float r, float g, float b, float a=1.0)
 
TColorUsine sdkAlphaColor (int r, int g, int b, int a=255)
 

Geometric Helpers

Various helpers around points, coords...

TPointF sdkPointF (float x, float y)
 Construct a TPointF. More...
 
bool sdkPointInRect (int X, int Y, TPointI LeftTop, TPointI RightBottom)
 Test if coordinate is in a rect bound. More...
 
bool sdkPointInRect (TPointI Coords, TPointI LeftTop, TPointI RightBottom)
 
bool sdkPointInRect (float X, float Y, TRectF rect)
 
TPointF sdkBezier4 (TPointF p1, TPointF p2, TPointF p3, TPointF p4, float mu)
 
float sdkBezier4 (float p1, float p2, float p3, float p4, float mu)
 

Detailed Description

Function Documentation

§ CreateModule()

void CreateModule ( void *&  pModule,
AnsiCharPtr  optionalString,
LongBool  Flag,
MasterInfo pMasterInfo,
AnsiCharPtr  optionalContent 
)

Called by Usine to instantiate the User Module When opening the Browser section where is stored the module.

When adding the module in a patch. When loading a saved workspace or patch.

Parameters
pModuleHandle for the new instanciated module
optionalString
Flag
pMasterInfoHandle to the MasterInfo structure
optionalContent

§ DestroyModule()

void DestroyModule ( void *  pModule)

Called by Usine to destroy the User Module When clearing a workspace or patch.

Before recreate module. When closing Usine.

§ GetBrowserInfo()

void GetBrowserInfo ( ModuleInfo pModuleInfo)

Called by usine to get module informations for the browser When the browser open the folder where the module is stored.

§ sdkPointF()

TPointF sdkPointF ( float  x,
float  y 
)

Construct a TPointF.

Parameters
xx coordinates
yy coordinates
Returns
The new point.

§ sdkPointInRect()

bool sdkPointInRect ( int  X,
int  Y,
TPointI  LeftTop,
TPointI  RightBottom 
)

Test if coordinate is in a rect bound.

Parameters
Xx coordinates to test
Yy coordinates to test
LeftTopLeft top coordinates of the rect bound
RightBottomRight bottom coordinates of the rect bound.
Returns
true if is in rect