class Sprocket

Defined in: C4Sprockets.h

The Sprocket class is used to modify a widget in some way over time.

Definition

class Sprocket : public ListElement<Sprocket>, public Packable, public Configurable, public Registrable<Sprocket, SprocketRegistration>

Member Functions

`Sprocket::GetSprocketType`	Returns the sprocket type.
`Sprocket::GetSprocketState`	Returns the sprocket state.
`Sprocket::SetSprocketState`	Sets the sprocket state.
`Sprocket::GetSprocketKey`	Returns the sprocket key.
`Sprocket::SetSprocketKey`	Sets the sprocket key.

Constructor

Sprocket(SprocketType type);

Parameters

type The sprocket type.

Description

The Sprocket class is the base class for all widget sprockets. Every widget has a list of sprockets that are applied to change its appearance over time. Sprockets are added to a widget by calling the Widget::AddSprocket function.

Base Classes

`ListElement<Sprocket>`	Used internally by the Interface Manager.
`Packable`	Sprockets can be packed for storage in resources.
`Configurable`	Sprockets can define configurable parameters that are exposed as user interface widgets in the Panel Editor.
`Registrable<Sprocket, SprocketRegistration>`	Custom sprocket types can be registered with the engine.