APIs

Show:
/**
 factory to create blocks and block property
 @class BlockFactory
 @constructor
 @return {Object} instantiated BlockFactory
 **/
define(['jquery', 'backbone', 'X2JS', 'fabric'], function ($, Backbone, X2JS, fabric) {

    /**
     All blocks and related property modules loaded by require.js
     @event BLOCKS_LOADED
     @param {This} caller
     @static
     @final
     **/
    BB.EVENTS.BLOCKS_LOADED = 'BLOCKS_LOADED';

    /**
     block.PLACEMENT_SCENE indicates the insertion is inside a Scene
     @property Block.PLACEMENT_SCENE
     @static
     @final
     @type String
     */
    BB.CONSTS.PLACEMENT_SCENE = 'PLACEMENT_SCENE';

    /**
     block.PLACEMENT_CHANNEL indicates the insertion is on the timeline_channel
     @property Block.PLACEMENT_CHANNEL
     @static
     @final
     @type String
     */
    BB.CONSTS.PLACEMENT_CHANNEL = 'PLACEMENT_CHANNEL';

    /**
     block.PLACEMENT_IS_SCENE indicates the insertion is itself a Scene
     @property Block.PLACEMENT_IS_SCENE
     @static
     @final
     @type String
     */
    BB.CONSTS.PLACEMENT_IS_SCENE = 'PLACEMENT_IS_SCENE';

    /**
     block.PLACEMENT_LISTS indicates the insertion is inside a collection list such
     as the Collection Block or the Location based block. This event is used for example
     when building the list of available blocks in AddBlockView
     @property Block.PLACEMENT_LISTS
     @static
     @final
     @type String
     */
    BB.CONSTS.PLACEMENT_LISTS = 'PLACEMENT_LISTS';

    BB.CONSTS.BLOCKCODE_SCENE = '3510';
    BB.CONSTS.BLOCKCODE_COLLECTION = '4100';
    BB.CONSTS.BLOCKCODE_TWITTER = '4500';
    BB.CONSTS.BLOCKCODE_TWITTER_ITEM = '4505';
    BB.CONSTS.BLOCKCODE_JSON = '4300';
    BB.CONSTS.BLOCKCODE_JSON_ITEM = '4310';
    BB.CONSTS.BLOCKCODE_WORLD_WEATHER = '6010';
    BB.CONSTS.BLOCKCODE_GOOGLE_SHEETS = '6022';
    BB.CONSTS.BLOCKCODE_CALENDAR = '6020';
    BB.CONSTS.BLOCKCODE_TWITTERV3 = '6230';
    BB.CONSTS.BLOCKCODE_INSTAGRAM = '6050';
    BB.CONSTS.BLOCKCODE_DIGG = '6000';
    BB.CONSTS.BLOCKCODE_IMAGE = '3130';
    BB.CONSTS.BLOCKCODE_SVG = '3140';
    BB.CONSTS.BLOCKCODE_VIDEO = '3100';

    BB.SERVICES.BLOCK_FACTORY = 'BlockFactory';

    var BlockFactory = BB.Controller.extend({

        /**
         Constructor
         @method initialize
         @return {} Unique clientId.
         **/
        initialize: function () {
            var self = this;
            BB.comBroker.setService(BB.SERVICES['BLOCK_FACTORY'], self);
            self.x2js = new X2JS({
                escapeMode: true,
                attributePrefix: "_",
                arrayAccessForm: "none",
                emptyNodeForm: "text",
                enableToStringFunc: true,
                arrayAccessFormPaths: [],
                skipEmptyTextNodesForObj: true
            });
            BB.comBroker.setService('compX2JS', this.x2js);
        },

        /**
         Load all block modules via require js and fire event to subscribers when all loaded
         @method loadBlockModules
         **/
        loadBlockModules: function () {
            var self = this;

            require(['BlockProperties',
                    'Block',
                    'BlockScene',
                    'BlockRSS',
                    'BlockQR',
                    'BlockYouTube',
                    'BlockCollection',
                    'BlockLocation',
                    'BlockFasterQ',
                    'BlockTwitter',
                    'BlockTwitterItem',
                    'BlockJson',
                    'BlockJsonItem',
                    'BlockWorldWeather',
                    'BlockGoogleSheets',
                    'BlockTwitterV3',
                    'BlockInstagram',
                    'BlockDigg',
                    'BlockVideo',
                    'BlockImage',
                    'BlockSVG',
                    'BlockExtImage',
                    'BlockExtVideo',
                    'BlockMRSS',
                    'BlockHTML',
                    'BlockGoogleCalendar',
                    'BlockLabel',
                    'BlockClock'],

                function (BlockProperties,
                          Block, BlockScene,
                          BlockRSS,
                          BlockQR,
                          BlockYouTube,
                          BlockCollection,
                          BlockLocation,
                          BlockFasterQ,
                          BlockTwitter,
                          BlockTwitterItem,
                          BlockJson,
                          BlockJsonItem,
                          BlockWorldWeather,
                          BlockGoogleSheets,
                          BlockTwitterV3,
                          BlockInstagram,
                          BlockDigg,
                          BlockVideo,
                          BlockImage,
                          BlockSVG,
                          BlockExtImage,
                          BlockExtVideo,
                          BlockMRSS,
                          BlockHTML,
                          BlockGoogleCalendar,
                          BlockLabel,
                          BlockClock) {

                    if (self.m_blockProperties)
                        return;

                    self.m_blockProperties = new BlockProperties({el: Elements.BLOCK_PROPERTIES});

                    self.m_block = Block;
                    self.m_blockScene = BlockScene;
                    self.m_blockRSS = BlockRSS;
                    self.m_blockQR = BlockQR;
                    self.m_blockYouTube = BlockYouTube;
                    self.m_blockCollection = BlockCollection;
                    self.m_blockLocation = BlockLocation
                    self.m_blockFasterQ = BlockFasterQ;
                    self.m_blockTwitter = BlockTwitter;
                    self.m_blockTwitterItem = BlockTwitterItem;
                    self.m_blockJson = BlockJson;
                    self.m_blockJsonItem = BlockJsonItem;
                    self.m_blockWorldWeather = BlockWorldWeather;
                    self.m_blockGoogleSheets = BlockGoogleSheets;
                    self.m_blockTwitterV3 = BlockTwitterV3;
                    self.m_blockInstagram = BlockInstagram;
                    self.m_blockDigg = BlockDigg;
                    self.m_blockVideo = BlockVideo;
                    self.m_blockImage = BlockImage;
                    self.m_blockSVG = BlockSVG;
                    self.m_blockExtImage = BlockExtImage;
                    self.m_blockExtVideo = BlockExtVideo;
                    self.m_blockMRSS = BlockMRSS;
                    self.m_blockHTML = BlockHTML;
                    self.m_blockGoogleCalendar = BlockGoogleCalendar;
                    self.m_blockLabel = BlockLabel;
                    self.m_blockClock = BlockClock;

                    BB.comBroker.fire(BB.EVENTS.BLOCKS_LOADED);
                });
        },

        /**
         This is factory method produces block instances which will reside on the timeline and referenced within this
         channel instance. The factory will parse the blockCode and create the appropriate block type.
         @method createBlock
         @param {Number} block_id
         @param {String} i_playerData
         @param {String} i_placement where does the block reside, scene or channel
         @param {Number} i_scene_id
         @return {Object} reference to the block instance
         **/
        createBlock: function (block_id, i_player_data, i_placement, i_scene_id) {
            var self = this;
            var block = undefined;
            // uncomment to see XML when adding new components
            // console.log(i_player_data);
            var playerData = this.x2js.xml_str2json(i_player_data);
            var blockCode;

            if (playerData['Player']['_player']) {
                // Standard block
                blockCode = playerData['Player']['_player'];
            } else {
                // Scene
                blockCode = BB.CONSTS.BLOCKCODE_SCENE;
                if (_.isUndefined(i_scene_id)) {
                    var domPlayerData = $.parseXML(i_player_data);
                    i_scene_id = $(domPlayerData).find('Player').attr('hDataSrc');
                }
            }
            switch (parseInt(blockCode)) {
                case parseInt(BB.CONSTS.BLOCKCODE_SCENE):
                {
                    block = new self.m_blockScene({
                        i_placement: i_placement,
                        i_block_id: block_id
                    });
                    break;
                }
                case 3345:
                {
                    block = new self.m_blockRSS({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case 3430:
                {
                    block = new self.m_blockQR({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case 4600:
                {
                    block = new self.m_blockYouTube({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_COLLECTION):
                {
                    block = new self.m_blockCollection({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case 4105:
                {
                    block = new self.m_blockLocation({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case 6100:
                {
                    block = new self.m_blockFasterQ({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_TWITTER):
                {
                    block = new self.m_blockTwitter({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_TWITTER_ITEM):
                {
                    block = new self.m_blockTwitterItem({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_WORLD_WEATHER):
                {
                    block = new self.m_blockWorldWeather({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_GOOGLE_SHEETS):
                {
                    block = new self.m_blockGoogleSheets({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_TWITTERV3):
                {
                    block = new self.m_blockTwitterV3({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_CALENDAR):
                {
                    block = new self.m_blockGoogleCalendar({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_INSTAGRAM):
                {
                    block = new self.m_blockInstagram({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_DIGG):
                {
                    block = new self.m_blockDigg({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_VIDEO):
                {
                    block = new self.m_blockVideo({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_SVG):
                {
                    block = new self.m_blockSVG({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_IMAGE):
                {
                    block = new self.m_blockImage({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case 3160:
                {
                    block = new self.m_blockExtImage({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case 3150:
                {
                    block = new self.m_blockExtVideo({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case 3320:
                {
                    block = new self.m_blockClock({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case 3235:
                {
                    block = new self.m_blockHTML({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case 3241:
                {
                    block = new self.m_blockLabel({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case 3340:
                {
                    block = new self.m_blockMRSS({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_JSON):
                {
                    block = new self.m_blockJson({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
                case parseInt(BB.CONSTS.BLOCKCODE_JSON_ITEM):
                {
                    block = new self.m_blockJsonItem({
                        i_placement: i_placement,
                        i_block_id: block_id,
                        i_scene_player_data_id: i_scene_id
                    });
                    break;
                }
            }

            // subclass our block from fabric.Group if resides inside scene
            if (i_placement == BB.CONSTS.PLACEMENT_SCENE) {
                var g = new fabric.Group([]);
                _.extend(block, g);
                g = undefined;
            }
            return block;
        },

        /**
         Get the status of modules, i.e.: loaded yet?
         @method blocksLoaded
         **/
        blocksLoaded: function () {
            var self = this;
            if (self.m_block)
                return true;
            return false;
        }
    });

    return BlockFactory;
});