Cicode Programming Reference > Cicode Function Categories > Display Functions Introduction > DspSymAtSize

DspSymAtSize

Displays a symbol at the specified scale and offset from the AN position.

By calling this function continuously, you can move symbols around the screen and change their size and shape, to simulate trippers, elevators, and so on. You change the PositionX, PositionY values to change the position of the symbol, the SizeX, SizeY values to change its size, or the symbol itself to change its shape.

You can only use this function at a blank AN, or an AN with a symbol defined without symbols configured. The AN needs to not be attached to any other animation object.

Note: This function is only used for V3.xx and V4.xx animations, and was superseded in later releases.

Syntax

DspSymAtSize(AN, sSym, PositionX, PositionY, SizeX, SizeY, Mode)

AN:

The AN where the symbol will be animated.

sSym:

The name of the symbol to display, move, or size. If sSym is 0 (zero), any existing symbol at the AN is erased.

PositionX:

The horizontal offset position (from the AN) of the symbol (in pixels).

PositionY:

The vertical offset position (from the AN) of the symbol (in pixels).

SizeX, SizeY:

The horizontal and vertical scaling factors for the symbol (0 - 32000). For example, if PositionX and PositionY are both 32000, the symbol is displayed at its normal size. Please be aware that symbols can only be reduced in size.

Mode:

The mode of the display:

-1 - Soft animation. The background screen (a rectangular region beneath the symbol) is restored with the original image. Any objects that are within the rectangular region are destroyed when the background is restored. Use this mode when each animation symbol is a different size.

0 - Overlap animation. The background screen (beneath the symbol) is not erased - the next symbol is displayed on top. Transparent color is supported in this mode, allowing for symbol overlap. For this mode to display correctly, each symbol needs to be the same size.

1 - Animate animation. The background screen (beneath the symbol) is not erased - the next symbol is displayed on top. This mode provides the fastest animation. For this mode to display correctly, each symbol needs to be the same size. Transparent color is not supported in this mode.

8 - Stops animation at last symbol displayed. Use this mode where you want to freeze your animation at the end of the sequence.

16 - Stops animation at current symbol displayed. Use this mode where you want to freeze your animation instantly.

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

DspAnMove, DspAnMoveRel, DspSym

Example

! Display tripper moving in x axis at normal size.
DspSymAtSize(21, "lib.tripper", x, 0, 32000, 32000, 0);
! Display elevator going up and down.
DspSymAtSize(22, "lib.elevator", 0, y, 32000, 32000, 0);
! Display can getting bigger and smaller.
DspSymAtSize(23, "lib.can", 0, 0, size, size, 0);

See Also

Display Functions