From time to time I get emails from people asking for help or advice and last week I was discussing with Gabe about how VOs might help him organize his code. I think a large amount of the visits to my blog come from Flash newbies and designers so this post is perhaps more for them as most developers will already know about VOs and will probably be using them all the time.
What is a VO?
A Value Object (VO) is as simple as it sounds, an object that stores values or data. An example of a VO is something as simple as this:
Where would you use a VO?
The place I use them most is when loading external XML into Flash for populating content. This could be page content, or something simple like a video gallery. Sticking with the gallery idea, below is an example of using VOs.
Imagine I had a simple gallery that was populated with XML:
<title>Video 1 header</title>
<title>Video 2 header</title>
<title>Video 3 header</title>
We could parse the data into a Vector of VideoVOs like the example below:
var l:int = xml.video.length();
var videos:Vector.<VideoVO> = new Vector.<VideoVO>(l, true);
for(i; i < l; ++i)
videos[i] = new VideoVO();
videos[i].id = xml.video[i].@id;
videos[i].src = xml.video[i].src;
videos[i].autoPlay = (xml.video[i].autoPlay == "true");
videos[i].width = Number(xml.video[i].width);
videos[i].height = Number(xml.video[i].height);
Now in your gallery you can just pass a VideoVO and all your data is organized so you don’t need to pass the XML object around, and remember the structure for referencing elements.
So why bother using VOs?
There are a couple of reasons that VOs are useful. Firstly, they help you keep your code organised. It’s a clear way of separating the data from your XML files and other Developers will find it easier to pick up your code. For example, say you have a massive XML file that defines the structure of a microsite, and one small part of that site is a video gallery. Someone working on the gallery doesn’t need to have any knowledge of the XML structure, you can just tell them to write code that expects a VideoVO.
Secondly it is quicker to update things. Say I am using the video data from my XML in several places throughout my code, and the XML structure changes. I would have to go through and edit every place within my project that references the XML. However, if I parse my XML once when it’s loaded, and store the data in VOs, I only have to change path referencing in one place.
Thirdly, if you have a massive XML, it will be quicker to use VOs rather than doing lookups in the XML every time you need data. OK not much quicker, in fact you will never notice the difference, but I believe it’s always worth making your code as optimised as possible.
Another good way of using VOs in Flash
Another place where you could use VOs is with a tweening engine that requires an object to be passed to it, for example TweenMax. So for example, using the same video gallery idea, you might want to have a transition to display the video view. You could create a simple TweenVO like this:
And then just pass the VO to your tweening engine like this:
tweenVO.rotationY = 30;
tweenVO.x = 20;
tweenVO.scaleX = .6;
TweenMax.from(video, 1, tweenVO);
If you know any other benefits, or perhaps negatives, for using VOs please make a comment. In fact any comments are always really appreciated.