Set the Colour value to alter the default fill that is used for currentColor references. Typically a standard RGB painter fill reference should be used for this purpose, e.g. rgb(255,255,255). It is however, also acceptable to use URL references to named definitions such as gradients and images. This will work as long as the named definition is registered in the top-level VectorScene object.

If this field is set to a valid frame number, the vector graphics will only be drawn when the frame of the container matches the Frame number in this field. When set to 0 (the default), the Vector will be drawn regardless of the container's frame number.

Referencing a function in this field will allow the client to receive a callback after the preparation of each animation frame (if the SVG object is being animated). This feature is commonly used to render the SVG document to a target Bitmap.

Note that if the SVG document does not make use of any animation features then the function will never be called.

The function prototype is void Function(*SVG).

This field defines the maximum frame rate that will be used when a vector scene is animated. It is recommended that a value between 50 and 100 is used. It is important to note that while higher frame rates produce smoother animations, they also increase the CPU usage proportionately. For instance, a frame rate of 100 will use the CPU twice as much as a frame rate of 50. This will subsequently have an effect on power consumption.

The recommended frame rate is 60, as this will match the majority of modern displays.

SVG data can be loaded from a file source by setting the Path field to an SVG file.

The Scene is a read-only field that assists in quickly finding the VectorScene that owns the Target object.

SVG data can be loaded from a string by specifying it here prior to initialisation. If the Path field has been defined, it will take precedent and the Statement is ignored.

Alternatively the DataFeed() action can be used to parse data on-the-fly after the SVG object is initialised.

During the normal initialisation process, a new VectorViewport is created to host the SVG scene graph. By default, the viewport and its content is strictly owned by the SVG object unless a Target is defined to redirect the scene graph elsewhere.

The provided Target can be any object class, as long as it forms part of a scene graph owned by a VectorScene object. It is recommended that the chosen target is a VectorViewport.

The use of a Target will make the generated scene graph independent of the SVG object. Consequently, it is possible to terminate the SVG object without impacting the resources it created. If tracking back to the SVG object is still required, use the ENFORCE_TRACKING option in Flags to ensure that SVG definitions are still terminated on object destruction.

The title of an SVG document is declared with a title element that can embedded anywhere in the document. In cases where a title has been specified, it will be possible to read it from this field. If no title is in the document then NULL will be returned.

This field simplifies the process of finding the first VectorViewport that was created by a loaded SVG document. NULL is returned if an SVG document has not been successfully parsed yet.