Graphical Objects - Overview

All objects that can visibly appear on a page in a publication can use the Graphical Object functions. This includes:

Text Objects

Buttons

Videos

Slideshows

Hierarchy:

As well as the specific functions listed under the Functions: heading below, you can also use the following OpusScript functions:

image\Script_Button.jpgBasic Object functions

Class Hierarchy:

Graphical Objects

image\Hierarchy_Level.jpg Basic Objects

Hierarchy of objects in Opus

Functions:

CaptureMouse

Capture the mouse input

CloneObject

Clone an object

CopyToClipboard

Copy an object to the Windows clipboard

DestroyClonedObject

Destroy a cloned object

Enable

Enable or disable this object

Fade

Fade an object by an amount

FollowPath

Make an object follow an animation path

GetAppearance

Get the appearance information for the object State of a specified object

GetDisplayData

Get display information related to an object e.g. scale and skew

GetHeight

Get the height of the object

GetLayer

Get the layer that the object is on

GetObjectDimensions

Get the position and size of an object

GetPersistentObject

Get an object for storing information that will persist when the page is not visible

GetPosition

Get the x and y coordinate of the objects position

GetPosition

Get the x and y coordinate of an animation path’s length

GetPositionFromPercent

Get the x and y coordinate of an animation path from a percent along the path

GetScrollInfo

Get the scroll position, scroll size and scrollbar

GetTotalLength

Get the total length of an animation path

GetWidth

Get the width of the object

GetXPosition

Get the x coordinate of the objects position

GetYPosition

Get the y coordinate of the objects position

Hide

Hide this object

IsEnabled

Test if this object is enabled

IsObjectIntersecting

Test if this object is intersecting another

IsShowing

Test if this object is showing

Move

Move the object by its x and y coordinates

MoveX

Move the object by its x coordinate

MoveY

Move the object by its y coordinate

ReleaseMouse

Release the mouse input

RemoveAlpha

Delete the Alpha effect on a specified object

RemoveBackground

Delete the Background style on a specified object

RemoveBorder

Delete the Border style on a specified object

RemoveBtnColour

Delete the Button style on a specified Button object

RemoveFlare

Delete the Flare effect on a specified object

RemoveImage

Delete the Image on a specified object

RemoveShadow

Delete the Shadow effect on a specified object

RemoveTexture

Delete the Texture effect on a specified object

ResetAnimation

Reset an animation

Roll

Roll an object by a specified angle

Rotate

Rotate an object by a specified angle

Scale

Scale an object horizontally and vertically by a percentage

ScaleH

Scale an object horizontally by a percentage

ScaleV

Scale an object vertically by a percentage

SetAlpha

Create an Alpha effect on a specified object

SetBackground

Create a Background style on a specified object

SetBorder

Create a Border style on a specified object

SetBtnColour

Create a Button style on a specified object

SetDisplayData

Set display information related to an object e.g.

SetFlare

Create a Flare effect on a specified object

SetFocus

Set the keyboard input focus

SetImage

Insert an Image on a specified object

SetLayer

Set the layer that the object is on

SetObjectDimensions

Set the position and size of an object

SetPosition

Set aspects of the objects position

SetPositionX

Set the x coordinate of the objects position

SetPositionY

Set the y coordinate of the objects position

SetRoll

Set an objects roll to a specified angle

SetRotation

Set an objects rotation to a specified angle

SetScale

Set the horizontal and vertical scale of an object to a percentage

SetScaleH

Set the horizontal scale of an object to a percentage

SetScaleV

Set the vertical scale of an object to a percentage

SetScrollPosition

Set the scroll position of the object

SetShadow

Create a Shadow effect on a specified object

SetSkew

Skew an object horizontally and vertically to a specified angle

SetSkewH

Skew an object horizontally to a specified angle

SetSkewV

Skew an object vertically to a specified angle

SetSpin

Set an objects spin to a specified angle

SetTexture

Create a Texture effect on a specifed object

SetTransparency

Set the transparency of an object

Show

Show this object

Skew

Set the skew of an object horizontally and vertically to a specified angle

SkewH

Set the skew of an object horizontally to a specified angle

SkewV

Set the skew of an object vertically to a specified angle

Spin

Spin an object by a specified angle

StopAnimation

Stop an animation