Using Shapes

Functions Provided For Setting Shapes

The following table provides an overview of all functions to modify shapes:

Function	Description
void SetRenderingMode(int mode)	Sets the Rendering Mode. Please use a constant as described below for mode.
int GetRenderingMode()	Returns the currently set Rendering Mode.
void SetShapeType(int value)	Sets the Shape Type. Please use a constant as described below for value.
int GetShapeType()	Returns the currently set Shape Type.
void SetShapeAlignment(int value)	Sets the Shape Alignment, which is the orientation of the shapes related to the matrix. Please use a constant as described below for value.
int GetShapeAlignment()	Returns the currently set Shape Alignment.
void SetShapeRotation(int value)	Sets the Rotation Type. Please use a constant as described below for value.
int GetShapeRotation()	Returns the currently set Rotation Type.
void SetShapeOrigin(int type)	Sets the Origin Type. Please use a constant as described below for type.
int GetShapeOrigin()	Returns the currently set Origin Type.

Remarks

Not all effects which use shapes offer Rendering Mode. Therefore, the functions SetRenderingMode and GetRenderingMode are only available, if the effect offers Rendering Mode.

Not all effects which use shapes offer Shape Alignment. Therefore, the functions SetShapeAlignment and GetShapeAlignment are only available, if the effect offers Shape Alignment.

Not all effects which use shapes offer Shape Rotation. Therefore, the functions SetShapeRotation and GetShapeRotation are only available, if the effect offers Shape Rotation.

Not all effects which use shapes offer Origin. Therefore, the functions SetShapeOrigin and GetShapeOrigin are only available, if the effect offers Origin.

Also, the effects mostly offer just a selection of all the constants, which are listed below. The function SetRenderingMode will only set Rendering Modes which are offered by the effect. The function SetShapeType will only set Shape Types which are offered by the effect. The function SetShapeAlignment will only set Shape Alignments which are offered by the effect.

Rendering Mode Constants

Constant	Description
int RENDERING_MODE_SIMPLE	Sets the Rendering Mode to Simple.
int RENDERING_MODE_EXTENDED	Sets the Rendering Mode to Extended.
int RENDERING_MODE_BLOBBY	Sets the Rendering Mode to Blobby.

Shape Type Constants

Constant	Description
int SHAPE_TYPE_LINE	Sets the Shape Type to Line.
int SHAPE_TYPE_CURVE	Sets the Shape Type to Curve.
int SHAPE_TYPE_FILLED	Sets the Shape Type to Filled.
int SHAPE_TYPE_RECTANGLE_OUTLINED	Sets the Shape Type to Rectangle Outlined.
int SHAPE_TYPE_RECTANGLE_OUTLINED_IMPLODE	Sets the Shape Type to Rectangle Outlined Implode.
int SHAPE_TYPE_RECTANGLE_OUTLINED_EXPLODE	Sets the Shape Type to Rectangle Outlined Explode.
int SHAPE_TYPE_RECTANGLE_FILLED	Sets the Shape Type to Rectangle Filled.
int SHAPE_TYPE_RECTANGLE_FILLED_IMPLODE	Sets the Shape Type to Rectangle Filled Implode.
int SHAPE_TYPE_RECTANGLE_FILLED_EXPLODE	Sets the Shape Type to Rectangle Filled Explode.
int SHAPE_TYPE_SQUARE_OUTLINED	Sets the Shape Type to Square Outlined.
int SHAPE_TYPE_SQUARE_OUTLINED_IMPLODE	Sets the Shape Type to Square Outlined Implode.
int SHAPE_TYPE_SQUARE_OUTLINED_EXPLODE	Sets the Shape Type to Square Outlined Explode.
int SHAPE_TYPE_SQUARE_FILLED	Sets the Shape Type to Square Filled.
int SHAPE_TYPE_SQUARE_FILLED_IMPLODE	Sets the Shape Type to Square Filled Implode.
int SHAPE_TYPE_SQUARE_FILLED_EXPLODE	Sets the Shape Type to Square Filled Explode.
int SHAPE_TYPE_ELLIPSE_OUTLINED	Sets the Shape Type to Ellipse Outlined.
int SHAPE_TYPE_ELLIPSE_OUTLINED_IMPLODE	Sets the Shape Type to Ellipse Outlined Implode.
int SHAPE_TYPE_ELLIPSE_OUTLINED_EXPLODE	Sets the Shape Type to Ellipse Outlined Explode.
int SHAPE_TYPE_ELLIPSE_FILLED	Sets the Shape Type to Ellipse Filled.
int SHAPE_TYPE_ELLIPSE_FILLED_IMPLODE	Sets the Shape Type to Ellipse Filled Implode.
int SHAPE_TYPE_ELLIPSE_FILLED_EXPLODE	Sets the Shape Type to Ellipse Filled Explode.
int SHAPE_TYPE_CIRCLE_OUTLINED	Sets the Shape Type to Circle Outlined.
int SHAPE_TYPE_CIRCLE_OUTLINED_IMPLODE	Sets the Shape Type to Circle Outlined Implode.
int SHAPE_TYPE_CIRCLE_OUTLINED_EXPLODE	Sets the Shape Type to Circle Outlined Explode.
int SHAPE_TYPE_CIRCLE_FILLED	Sets the Shape Type to Circle Filled.
int SHAPE_TYPE_CIRCLE_FILLED_IMPLODE	Sets the Shape Type to Circle Filled Implode.
int SHAPE_TYPE_CIRCLE_FILLED_EXPLODE	Sets the Shape Type to Circle Filled Explode.
int SHAPE_TYPE_DIAMOND_OUTLINED	Sets the Shape Type to Diamond Outlined.
int SHAPE_TYPE_DIAMOND_OUTLINED_IMPLODE	Sets the Shape Type to Diamond Outlined Implode.
int SHAPE_TYPE_DIAMOND_OUTLINED_EXPLODE	Sets the Shape Type to Diamond Outlined Explode.
int SHAPE_TYPE_DIAMOND_FILLED	Sets the Shape Type to Diamond Filled.
int SHAPE_TYPE_DIAMOND_FILLED_IMPLODE	Sets the Shape Type to Diamond Filled Implode.
int SHAPE_TYPE_DIAMOND_FILLED_EXPLODE	Sets the Shape Type to Diamond Filled Explode.
int SHAPE_TYPE_HEART_OUTLINED	Sets the Shape Type to Heart Outlined.
int SHAPE_TYPE_HEART_OUTLINED_IMPLODE	Sets the Shape Type to Heart Outlined Implode.
int SHAPE_TYPE_HEART_OUTLINED_EXPLODE	Sets the Shape Type to Heart Outlined Explode.
int SHAPE_TYPE_HEART_FILLED	Sets the Shape Type to Heart Filled.
int SHAPE_TYPE_HEART_FILLED_IMPLODE	Sets the Shape Type to Heart Filled Implode.
int SHAPE_TYPE_HEART_FILLED_EXPLODE	Sets the Shape Type to Heart Filled Explode.
int SHAPE_TYPE_CROSS_OUTLINED	Sets the Shape Type to Cross Outlined.
int SHAPE_TYPE_CROSS_OUTLINED_IMPLODE	Sets the Shape Type to Cross Outlined Implode.
int SHAPE_TYPE_CROSS_OUTLINED_EXPLODE	Sets the Shape Type to Cross Outlined Explode.
int SHAPE_TYPE_CROSS_FILLED	Sets the Shape Type to Cross Filled.
int SHAPE_TYPE_CROSS_FILLED_IMPLODE	Sets the Shape Type to Cross Filled Implode.
int SHAPE_TYPE_CROSS_FILLED_EXPLODE	Sets the Shape Type to Cross Filled Explode.
int SHAPE_TYPE_CROSS_STRAIGHT_OUTLINED	Sets the Shape Type to Cross Straight Outlined.
int SHAPE_TYPE_CROSS_STRAIGHT_OUTLINED_IMPLODE	Sets the Shape Type to Cross Straight Outlined Implode.
int SHAPE_TYPE_CROSS_STRAIGHT_OUTLINED_EXPLODE	Sets the Shape Type to Cross Straight Outlined Explode.
int SHAPE_TYPE_CROSS_STRAIGHT_FILLED	Sets the Shape Type to Cross Straight Filled.
int SHAPE_TYPE_CROSS_STRAIGHT_FILLED_IMPLODE	Sets the Shape Type to Cross Straight Filled Implode.
int SHAPE_TYPE_CROSS_STRAIGHT_FILLED_EXPLODE	Sets the Shape Type to Cross Straight Filled Explode.
int SHAPE_TYPE_STAR_OUTLINED	Sets the Shape Type to Star Outlined.
int SHAPE_TYPE_STAR_OUTLINED_IMPLODE	Sets the Shape Type to Star Outlined Implode.
int SHAPE_TYPE_STAR_OUTLINED_EXPLODE	Sets the Shape Type to Star Outlined Explode.
int SHAPE_TYPE_STAR_FILLED	Sets the Shape Type to Star Filled.
int SHAPE_TYPE_STAR_FILLED_IMPLODE	Sets the Shape Type to Star Filled Implode.
int SHAPE_TYPE_STAR_FILLED_EXPLODE	Sets the Shape Type to Star Filled Explode.
int SHAPE_TYPE_TRIANGLE_OUTLINED	Sets the Shape Type to Triangle Outlined.
int SHAPE_TYPE_TRIANGLE_OUTLINED_IMPLODE	Sets the Shape Type to Triangle Outlined Implode.
int SHAPE_TYPE_TRIANGLE_OUTLINED_EXPLODE	Sets the Shape Type to Triangle Outlined Explode.
int SHAPE_TYPE_TRIANGLE_FILLED	Sets the Shape Type to Triangle Filled.
int SHAPE_TYPE_TRIANGLE_FILLED_IMPLODE	Sets the Shape Type to Triangle Filled Implode.
int SHAPE_TYPE_TRIANGLE_FILLED_EXPLODE	Sets the Shape Type to Triangle Filled Explode.
int SHAPE_TYPE_BOX_OUTLINED	Sets the Shape Type to 3D Box Outlined.
int SHAPE_TYPE_BOX_OUTLINED_IMPLODE	Sets the Shape Type to 3D Box Outlined Implode.
int SHAPE_TYPE_BOX_OUTLINED_EXPLODE	Sets the Shape Type to 3D Box Outlined Explode.
int SHAPE_TYPE_BOX_UNFILLED	Sets the Shape Type to 3D Box Unfilled.
int SHAPE_TYPE_BOX_UNFILLED_IMPLODE	Sets the Shape Type to 3D Box Unfilled Implode.
int SHAPE_TYPE_BOX_UNFILLED_EXPLODE	Sets the Shape Type to 3D Box Unfilled Explode.
int SHAPE_TYPE_BOX_FILLED	Sets the Shape Type to 3D Box Filled.
int SHAPE_TYPE_BOX_FILLED_IMPLODE	Sets the Shape Type to 3D Box Filled Implode.
int SHAPE_TYPE_BOX_FILLED_EXPLODE	Sets the Shape Type to 3D Box Filled Explode.
int SHAPE_TYPE_CUBE_OUTLINED	Sets the Shape Type to 3D Cube Outlined.
int SHAPE_TYPE_CUBE_OUTLINED_IMPLODE	Sets the Shape Type to 3D Cube Outlined Implode.
int SHAPE_TYPE_CUBE_OUTLINED_EXPLODE	Sets the Shape Type to 3D Cube Outlined Explode.
int SHAPE_TYPE_CUBE_UNFILLED	Sets the Shape Type to 3D Cube Unfilled.
int SHAPE_TYPE_CUBE_UNFILLED_IMPLODE	Sets the Shape Type to 3D Cube Unfilled Implode.
int SHAPE_TYPE_CUBE_UNFILLED_EXPLODE	Sets the Shape Type to 3D Cube Unfilled Explode.
int SHAPE_TYPE_CUBE_FILLED	Sets the Shape Type to 3D Cube Filled.
int SHAPE_TYPE_CUBE_FILLED_IMPLODE	Sets the Shape Type to 3D Cube Filled Implode.
int SHAPE_TYPE_CUBE_FILLED_EXPLODE	Sets the Shape Type to 3D Cube Filled Explode.
int SHAPE_TYPE_SPHERE_UNFILLED	Sets the Shape Type to 3D Sphere Unfilled.
int SHAPE_TYPE_SPHERE_UNFILLED_IMPLODE	Sets the Shape Type to 3D Sphere Unfilled Implode.
int SHAPE_TYPE_SPHERE_UNFILLED_EXPLODE	Sets the Shape Type to 3D Sphere Unfilled Explode.
int SHAPE_TYPE_SPHERE_FILLED	Sets the Shape Type to 3D Sphere Filled.
int SHAPE_TYPE_SPHERE_FILLED_IMPLODE	Sets the Shape Type to 3D Sphere Filled Implode.
int SHAPE_TYPE_SPHERE_FILLED_EXPLODE	Sets the Shape Type to 3D Sphere Filled Explode.
int SHAPE_TYPE_ELLIPSOID_UNFILLED	Sets the Shape Type to 3D Ellipsoid Unfilled.
int SHAPE_TYPE_ELLIPSOID_UNFILLED_IMPLODE	Sets the Shape Type to 3D Ellipsoid Unfilled Implode.
int SHAPE_TYPE_ELLIPSOID_UNFILLED_EXPLODE	Sets the Shape Type to 3D Ellipsoid Unfilled Explode.
int SHAPE_TYPE_ELLIPSOID_FILLED	Sets the Shape Type to 3D Ellipsoid Filled.
int SHAPE_TYPE_ELLIPSOID_FILLED_IMPLODE	Sets the Shape Type to 3D Ellipsoid Filled Implode.
int SHAPE_TYPE_ELLIPSOID_FILLED_EXPLODE	Sets the Shape Type to 3D Ellipsoid Filled Explode.
int SHAPE_TYPE_OCTAHEDRON_UNFILLED	Sets the Shape Type to 3D Octahedron Unfilled.
int SHAPE_TYPE_OCTAHEDRON_UNFILLED_IMPLODE	Sets the Shape Type to 3D Octahedron Unfilled Implode.
int SHAPE_TYPE_OCTAHEDRON_UNFILLED_EXPLODE	Sets the Shape Type to 3D Octahedron Unfilled Explode.
int SHAPE_TYPE_OCTAHEDRON_FILLED	Sets the Shape Type to 3D Octahedron Filled.
int SHAPE_TYPE_OCTAHEDRON_FILLED_IMPLODE	Sets the Shape Type to 3D Octahedron Filled Implode.
int SHAPE_TYPE_OCTAHEDRON_FILLED_EXPLODE	Sets the Shape Type to 3D Octahedron Filled Explode.
int SHAPE_TYPE_3D_HEART_UNFILLED	Sets the Shape Type to 3D Heart Unfilled.
int SHAPE_TYPE_3D_HEART_UNFILLED_IMPLODE	Sets the Shape Type to 3D Heart Unfilled Implode.
int SHAPE_TYPE_3D_HEART_UNFILLED_EXPLODE	Sets the Shape Type to 3D Heart Unfilled Explode.
int SHAPE_TYPE_3D_HEART_FILLED	Sets the Shape Type to 3D Heart Filled.
int SHAPE_TYPE_3D_HEART_FILLED_IMPLODE	Sets the Shape Type to 3D Heart Filled Implode.
int SHAPE_TYPE_3D_HEART_FILLED_EXPLODE	Sets the Shape Type to 3D Heart Filled Explode.
int SHAPE_TYPE_3D_STAR_UNFILLED	Sets the Shape Type to 3D Star Unfilled.
int SHAPE_TYPE_3D_STAR_UNFILLED_IMPLODE	Sets the Shape Type to 3D Star Unfilled Implode.
int SHAPE_TYPE_3D_STAR_UNFILLED_EXPLODE	Sets the Shape Type to 3D Star Unfilled Explode.
int SHAPE_TYPE_3D_STAR_FILLED	Sets the Shape Type to 3D Star Filled.
int SHAPE_TYPE_3D_STAR_FILLED_IMPLODE	Sets the Shape Type to 3D Star Filled Implode.
int SHAPE_TYPE_3D_STAR_FILLED_EXPLODE	Sets the Shape Type to 3D Star Filled Explode.
int SHAPE_TYPE_3D_CROSS_UNFILLED	Sets the Shape Type to 3D Cross Unfilled.
int SHAPE_TYPE_3D_CROSS_UNFILLED_IMPLODE	Sets the Shape Type to 3D Cross Unfilled Implode.
int SHAPE_TYPE_3D_CROSS_UNFILLED_EXPLODE	Sets the Shape Type to 3D Cross Unfilled Explode.
int SHAPE_TYPE_3D_CROSS_FILLED	Sets the Shape Type to 3D Cross Filled.
int SHAPE_TYPE_3D_CROSS_FILLED_IMPLODE	Sets the Shape Type to 3D Cross Filled Implode.
int SHAPE_TYPE_3D_CROSS_FILLED_EXPLODE	Sets the Shape Type to 3D Cross Filled Explode.
int SHAPE_TYPE_3D_CROSS_STRAIGHT_UNFILLED	Sets the Shape Type to 3D Cross Straight Unfilled.
int SHAPE_TYPE_3D_CROSS_STRAIGHT_UNFILLED_IMPLODE	Sets the Shape Type to 3D Cross Straight Unfilled Implode.
int SHAPE_TYPE_3D_CROSS_STRAIGHT_UNFILLED_EXPLODE	Sets the Shape Type to 3D Cross Straight Unfilled Explode.
int SHAPE_TYPE_3D_CROSS_STRAIGHT_FILLED	Sets the Shape Type to 3D Cross Straight Filled.
int SHAPE_TYPE_3D_CROSS_STRAIGHT_FILLED_IMPLODE	Sets the Shape Type to 3D Cross Straight Filled Implode.
int SHAPE_TYPE_3D_CROSS_STRAIGHT_FILLED_EXPLODE	Sets the Shape Type to 3D Cross Straight Filled Explode.
int SHAPE_TYPE_PYRAMID_UNFILLED	Sets the Shape Type to 3D Pyramid Unfilled.
int SHAPE_TYPE_PYRAMID_UNFILLED_IMPLODE	Sets the Shape Type to 3D Pyramid Unfilled Implode.
int SHAPE_TYPE_PYRAMID_UNFILLED_EXPLODE	Sets the Shape Type to 3D Pyramid Unfilled Explode.
int SHAPE_TYPE_PYRAMID_FILLED	Sets the Shape Type to 3D Pyramid Filled.
int SHAPE_TYPE_PYRAMID_FILLED_IMPLODE	Sets the Shape Type to 3D Pyramid Filled Implode.
int SHAPE_TYPE_PYRAMID_FILLED_EXPLODE	Sets the Shape Type to 3D Pyramid Filled Explode.
int SHAPE_TYPE_TEXT	Sets the Shape Type to Text.
int SHAPE_TYPE_WAVE_LINEAR	Sets the Shape Type to Wave Linear.
int SHAPE_TYPE_WAVE_RADAR	Sets the Shape Type to Wave Radar.
int SHAPE_TYPE_WAVE_HELIX	Sets the Shape Type to Wave Helix.
int SHAPE_TYPE_WAVE_CIRCLE	Sets the Shape Type to Wave Circle.
int SHAPE_TYPE_WAVE_SQUARE	Sets the Shape Type to Wave Square.
int SHAPE_TYPE_WAVE_DIAMOND	Sets the Shape Type to Wave Diamond.
int SHAPE_TYPE_WAVE_SPHERE	Sets the Shape Type to Wave Sphere.
int SHAPE_TYPE_WAVE_CUBE	Sets the Shape Type to Wave Cube.
int SHAPE_TYPE_WAVE_OCTAHEDRON	Sets the Shape Type to Wave Octahedron.
int SHAPE_TYPE_RANDOM	Selects an available Shape Type for each shape randomly. Sets the Shape Type to Random.
int SHAPE_TYPE_RANDOM_STATIC	Sets the Shape Type to Random Static.
int SHAPE_TYPE_RANDOM_IMPLODE	Sets the Shape Type to Random Implode.
int SHAPE_TYPE_RANDOM_EXPLODE	Sets the Shape Type to Random Explode.
int SHAPE_TYPE_RANDOM_OUTLINED	Sets the Shape Type to Random Outlined.
int SHAPE_TYPE_RANDOM_OUTLINED_STATIC	Sets the Shape Type to Random Outlined Static.
int SHAPE_TYPE_RANDOM_OUTLINED_IMPLODE	Sets the Shape Type to Random Outlined Implode.
int SHAPE_TYPE_RANDOM_OUTLINED_EXPLODE	Sets the Shape Type to Random Outlined Explode.
int SHAPE_TYPE_RANDOM_UNFILLED	Sets the Shape Type to Random Unfilled.
int SHAPE_TYPE_RANDOM_UNFILLED_STATIC	Sets the Shape Type to Random Unfilled Static.
int SHAPE_TYPE_RANDOM_UNFILLED_IMPLODE	Sets the Shape Type to Random Unfilled Implode.
int SHAPE_TYPE_RANDOM_UNFILLED_EXPLODE	Sets the Shape Type to Random Unfilled Explode.
int SHAPE_TYPE_RANDOM_FILLED	Sets the Shape Type to Random Filled.
int SHAPE_TYPE_RANDOM_FILLED_STATIC	Sets the Shape Type to Random Filled Static.
int SHAPE_TYPE_RANDOM_FILLED_IMPLODE	Sets the Shape Type to Random Filled Implode.
int SHAPE_TYPE_RANDOM_FILLED_EXPLODE	Sets the Shape Type to Random Filled Explode.
int SHAPE_TYPE_2D_RANDOM	Sets the Shape Type to 2D Random.
int SHAPE_TYPE_2D_RANDOM_STATIC	Sets the Shape Type to 2D Random Static.
int SHAPE_TYPE_2D_RANDOM_IMPLODE	Sets the Shape Type to 2D Random Implode.
int SHAPE_TYPE_2D_RANDOM_EXPLODE	Sets the Shape Type to 2D Random Explode.
int SHAPE_TYPE_2D_RANDOM_OUTLINED	Sets the Shape Type to 2D Random Outlined.
int SHAPE_TYPE_2D_RANDOM_OUTLINED_Static	Sets the Shape Type to 2D Random Outlined Static.
int SHAPE_TYPE_2D_RANDOM_OUTLINED_IMPLODE	Sets the Shape Type to 2D Random Outlined Implode.
int SHAPE_TYPE_2D_RANDOM_OUTLINED_EXPLODE	Sets the Shape Type to 2D Random Outlined Explode.
int SHAPE_TYPE_2D_RANDOM_FILLED	Sets the Shape Type to 2D Random Filled.
int SHAPE_TYPE_2D_RANDOM_FILLED_STATIC	Sets the Shape Type to 2D Random Filled Static.
int SHAPE_TYPE_2D_RANDOM_FILLED_IMPLODE	Sets the Shape Type to 2D Random Filled Implode.
int SHAPE_TYPE_2D_RANDOM_FILLED_EXPLODE	Sets the Shape Type to 2D Random Filled Explode.
int SHAPE_TYPE_3D_RANDOM	Sets the Shape Type to 3D Random.
int SHAPE_TYPE_3D_RANDOM_STATIC	Sets the Shape Type to 3D Random Static.
int SHAPE_TYPE_3D_RANDOM_IMPLODE	Sets the Shape Type to 3D Random Implode.
int SHAPE_TYPE_3D_RANDOM_EXPLODE	Sets the Shape Type to 3D Random Explode.
int SHAPE_TYPE_3D_RANDOM_UNFILLED	Sets the Shape Type to 3D Random Unfilled.
int SHAPE_TYPE_3D_RANDOM_UNFILLED_STATIC	Sets the Shape Type to 3D Random Unfilled Static.
int SHAPE_TYPE_3D_RANDOM_UNFILLED_IMPLODE	Sets the Shape Type to 3D Random Unfilled Implode.
int SHAPE_TYPE_3D_RANDOM_UNFILLED_EXPLODE	Sets the Shape Type to 3D Random Unfilled Explode.
int SHAPE_TYPE_3D_RANDOM_FILLED	Sets the Shape Type to 3D Random Filled.
int SHAPE_TYPE_3D_RANDOM_FILLED_STATIC	Sets the Shape Type to 3D Random Filled Static.
int SHAPE_TYPE_3D_RANDOM_FILLED_IMPLODE	Sets the Shape Type to 3D Random Filled Implode.
int SHAPE_TYPE_3D_RANDOM_FILLED_EXPLODE	Sets the Shape Type to 3D Random Filled Explode.

Shape Alignment Constants

Constant	Description
int LOOKAT_FRONT	Sets the Shape Alignment to Front.
int LOOKAT_BACK	Sets the Shape Alignment to Back.
int LOOKAT_LEFT	Sets the Shape Alignment to Left.
int LOOKAT_RIGHT	Sets the Shape Alignment to Right.
int LOOKAT_TOP	Sets the Shape Alignment to Top.
int LOOKAT_BOTTOM	Sets the Shape Alignment to Bottom.
int LOOKAT_RANDOM	Selects an available Shape Alignment for each shape randomly. Sets the Shape Alignment to Random.

Rotation Mode Constants

Constant	Description
int ROTATION_CCW_0	Does not activate Rotation. Is the same as ROTATION_CW_0.
int ROTATION_CCW_90	Rotates by 90 degrees in counter-clockwise direction. Is the same as ROTATION_CW_270.
int ROTATION_CCW_180	Rotates by 180 degrees in counter-clockwise direction. Is the same as ROTATION_CW_180.
int ROTATION_CCW_270	Rotates by 270 degrees in counter-clockwise direction. Is the same as ROTATION_CW_90.
int ROTATION_CW_0	Does not activate Rotation. Is the same as ROTATION_CCW_0.
int ROTATION_CW_90	Rotates by 90 degrees in clockwise direction. Is the same as ROTATION_CCW_270.
int ROTATION_CW_180	Rotates by 180 degrees in clockwise direction. Is the same as ROTATION_CCW_180.
int ROTATION_CW_270	Rotates by 270 degrees in clockwise direction. Is the same as ROTATION_CCW_90.

Origin Type Constants

Constant	Description
int ORIGIN_CENTER	Sets the Origin Type to Center.
int ORIGIN_FRONT	Sets the Origin Type to Front.
int ORIGIN_BACK	Sets the Origin Type to Back.
int ORIGIN_LEFT	Sets the Origin Type to Left.
int ORIGIN_RIGHT	Sets the Origin Type to Right.
int ORIGIN_TOP	Sets the Origin Type to Top.
int ORIGIN_BOTTOM	Sets the Origin Type to Bottom.
int ORIGIN_TOP_LEFT	Sets the Origin Type to Top Left.
int ORIGIN_TOP_RIGHT	Sets the Origin Type to Top Right.
int ORIGIN_BOTTOM_LEFT	Sets the Origin Type to Bottom Left.
int ORIGIN_BOTTOM_RIGHT	Sets the Origin Type to Bottom Right.
int ORIGIN_FRONT_LEFT	Sets the Origin Type to Front Left.
int ORIGIN_FRONT_RIGHT	Sets the Origin Type to Front Right.
int ORIGIN_BACK_LEFT	Sets the Origin Type to Back Left.
int ORIGIN_BACK_RIGHT	Sets the Origin Type to Back Right.
int ORIGIN_FRONT_TOP	Sets the Origin Type to Front Top.
int ORIGIN_FRONT_BOTTOM	Sets the Origin Type to Front Bottom.
int ORIGIN_BACK_TOP	Sets the Origin Type to Back Top.
int ORIGIN_BACK_BOTTOM	Sets the Origin Type to Back Bottom.
int ORIGIN_FRONT_TOP_LEFT	Sets the Origin Type to Front Top Left.
int ORIGIN_FRONT_TOP_RIGHT	Sets the Origin Type to Front Top Right.
int ORIGIN_FRONT_BOTTOM_LEFT	Sets the Origin Type to Front Bottom Left.
int ORIGIN_FRONT_BOTTOM_RIGHT	Sets the Origin Type to Front Bottom Right.
int ORIGIN_BACK_TOP_LEFT	Sets the Origin Type to Back Top Left.
int ORIGIN_BACK_TOP_RIGHT	Sets the Origin Type to Back Top Right.
int ORIGIN_BACK_BOTTOM_LEFT	Sets the Origin Type to Back Bottom Left.
int ORIGIN_BACK_BOTTOM_RIGHT	Sets the Origin Type to Back Bottom Right.

Deprecated Functions

Deprecated functions/constants are outdated functions and should not be used anymore.

Function/Constant	Description
int SHAPE_TYPE_CROSS	Use SHAPE_TYPE_CROSS_FILLED instead.
int SHAPE_TYPE_CROSS_IMPLODE	Use SHAPE_TYPE_CROSS_FILLED_IMPLODE instead.
int SHAPE_TYPE_CROSS_EXPLODE	Use SHAPE_TYPE_CROSS_FILLED_EXPLODE instead.
int SHAPE_TYPE_STAR	Use SHAPE_TYPE_STAR_FILLED instead.
int SHAPE_TYPE_STAR_IMPLODE	Use SHAPE_TYPE_STAR_FILLED_IMPLODE instead.
int SHAPE_TYPE_STAR_EXPLODE	Use SHAPE_TYPE_STAR_FILLED_EXPLODE instead.

MADRIX 2.X To MADRIX 3.X Migration Hints

The following functions and constants are not supported anymore. Please follow the hints to migrate your macros.

Function/Constant	Description
void SetShape(int shape)	Use SetShapeType(int value) instead.
int GetShape()	Use GetShapeType() instead.
void SetDrawShape(int shape)	Use SetShapeType(int value) instead.
int GetDrawShape()	Use GetShapeType() instead.
DRAW_LINE	Use SHAPE_TYPE_LINE instead.
DRAW_CURVE	Use SHAPE_TYPE_CURVE instead.
DRAW_RECT	Use SHAPE_TYPE_RECTANGLE_OUTLINED or SHAPE_TYPE_SQuare_OUTLINED instead, depending on the provided shape types of the effect and the desired result.
DRAW_RECT_IMPLODE	Use SHAPE_TYPE_RECTANGLE_OUTLINED_IMPLODE or SHAPE_TYPE_SQuare_OUTLINED_IMPLODE instead, depending on the provided shape types of the effect and the desired result.
DRAW_RECT_EXPLODE	Use SHAPE_TYPE_RECTANGLE_OUTLINED_EXPLODE or SHAPE_TYPE_SQuare_OUTLINED_EXPLODE instead, depending on the provided shape types of the effect and the desired result.
FILL_RECT	Use SHAPE_TYPE_RECTANGLE_FILLED or SHAPE_TYPE_SQuare_FILLED instead, depending on the provided shape types of the effect and the desired result.
FILL_RECT_IMPLODE	Use SHAPE_TYPE_RECTANGLE_FILLED_IMPLODE or SHAPE_TYPE_SQuare_FILLED_IMPLODE instead, depending on the provided shape types of the effect and the desired result.
FILL_RECT_EXPLODE	Use SHAPE_TYPE_RECTANGLE_FILLED_EXPLODE or SHAPE_TYPE_SQuare_FILLED_EXPLODE instead, depending on the provided shape types of the effect and the desired result.
DRAW_CIRCLE	Use SHAPE_TYPE_ELLIPSE_OUTLINED or SHAPE_TYPE_CIRCLE_OUTLINED instead, depending on the provided shape types of the effect and the desired result.
DRAW_CIRCLE_IMPLODE	Use SHAPE_TYPE_ELLIPSE_OUTLINED_IMPLODE or SHAPE_TYPE_CIRCLE_OUTLINED_IMPLODE instead, depending on the provided shape types of the effect and the desired result.
DRAW_CIRCLE_EXPLODE	Use SHAPE_TYPE_ELLIPSE_OUTLINED_EXPLODE or SHAPE_TYPE_CIRCLE_OUTLINED_EXPLODE instead, depending on the provided shape types of the effect and the desired result.
FILL_CIRCLE	Use SHAPE_TYPE_ELLIPSE_FILLED or SHAPE_TYPE_CIRCLE_FILLED instead, depending on the provided shape types of the effect and the desired result.
FILL_CIRCLE_IMPLODE	Use SHAPE_TYPE_ELLIPSE_FILLED_IMPLODE or SHAPE_TYPE_CIRCLE_FILLED_IMPLODE instead, depending on the provided shape types of the effect and the desired result.
FILL_CIRCLE_EXPLODE	Use SHAPE_TYPE_ELLIPSE_FILLED_EXPLODE or SHAPE_TYPE_CIRCLE_FILLED_EXPLODE instead, depending on the provided shape types of the effect and the desired result.
DRAW_DIAMOND	Use SHAPE_TYPE_DIAMOND_OUTLINED instead.
DRAW_DIAMOND_IMPLODE	Use SHAPE_TYPE_DIAMOND_OUTLINED_IMPLODE instead.
DRAW_DIAMOND_EXPLODE	Use SHAPE_TYPE_DIAMOND_OUTLINED_EXPLODE instead.
FILL_DIAMOND	Use SHAPE_TYPE_DIAMOND_FILLED instead.
FILL_DIAMOND_IMPLODE	Use SHAPE_TYPE_DIAMOND_FILLED_IMPLODE instead.
FILL_DIAMOND_EXPLODE	Use SHAPE_TYPE_DIAMOND_FILLED_EXPLODE instead.
DRAW_CROSS	Use SHAPE_TYPE_CROSS instead.
DRAW_CROSS_IMPLODE	Use SHAPE_TYPE_CROSS_IMPLODE instead.
DRAW_CROSS_EXPLODE	Use SHAPE_TYPE_CROSS_EXPLODE instead.
DRAW_STAR	Use SHAPE_TYPE_STAR instead.
DRAW_STAR_IMPLODE	Use SHAPE_TYPE_STAR_IMPLODE instead.
DRAW_STAR_EXPLODE	Use SHAPE_TYPE_STAR_EXPLODE instead.
DRAW_RANDOM	Use SHAPE_TYPE_RANDOM instead.
DRAW_TEXT	Use SHAPE_TYPE_TEXT instead.

Example

This example changes the shape type each second in a predefined order. It works with the »SCE Shapes effect, for example.

@scriptname="";

@author="";

@version="";

@description="";

int g_startTime;

int g_run;

void InitEffect()

{

time t = GetTime();

g_startTime = t.hour * 3600 + t.min * 60 + t.sec;

g_run = 0;

}

void PreRenderEffect()

{

time t = GetTime();

int t2 = t.hour * 3600 + t.min * 60 + t.sec;

if(t2 - g_startTime >= 1)

{

g_startTime = t2;

switch(g_run % 6)

{

case 0: SetShapeType(SHAPE_TYPE_CIRCLE_OUTLINED_EXPLODE); break;

case 1: SetShapeType(SHAPE_TYPE_CIRCLE_OUTLINED); break;

case 2: SetShapeType(SHAPE_TYPE_CIRCLE_OUTLINED_IMPLODE); break;

case 3: SetShapeType(SHAPE_TYPE_SQUARE_OUTLINED_EXPLODE); break;

case 4: SetShapeType(SHAPE_TYPE_SQUARE_OUTLINED); break;

case 5: SetShapeType(SHAPE_TYPE_SQUARE_OUTLINED_IMPLODE); break;

default: break;

}

g_run++;

}

void PostRenderEffect()

{

}

void MatrixSizeChanged()

{

InitEffect();

}