OOJSVisualEffect.m

Go to the documentation of this file.

/*
OOJSVisualEffect.m
 
Oolite
Copyright (C) 2004-2013 Giles C Williams and contributors
 
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
MA 02110-1301, USA.
 
 */
 
#import "OOVisualEffectEntity.h"
#import "OOJSVisualEffect.h"
#import "OOJSEntity.h"
#import "OOJSVector.h"
#import "OOJavaScriptEngine.h"
#import "OOMesh.h"
#import "OOCollectionExtractors.h"
#import "ResourceManager.h"
#import "EntityOOJavaScriptExtensions.h"
 
 
static JSObject     *sVisualEffectPrototype;
 
static BOOL JSVisualEffectGetVisualEffectEntity(JSContext *context, JSObject *stationObj, OOVisualEffectEntity **outEntity);
 
 
static JSBool VisualEffectGetProperty(JSContext *context, JSObject *this, jsid propID, jsval *value);
static JSBool VisualEffectSetProperty(JSContext *context, JSObject *this, jsid propID, JSBool strict, jsval *value);
 
static JSBool VisualEffectRemove(JSContext *context, uintN argc, jsval *vp);
static JSBool VisualEffectGetShaders(JSContext *context, uintN argc, jsval *vp);
static JSBool VisualEffectSetShaders(JSContext *context, uintN argc, jsval *vp);
static JSBool VisualEffectGetMaterials(JSContext *context, uintN argc, jsval *vp);
static JSBool VisualEffectSetMaterials(JSContext *context, uintN argc, jsval *vp);
static JSBool VisualEffectScale(JSContext *context, uintN argc, jsval *vp);
static JSBool VisualEffectRestoreSubEntities(JSContext *context, uintN argc, jsval *vp);
 
static JSBool VisualEffectSetMaterialsInternal(JSContext *context, uintN argc, jsval *vp, OOVisualEffectEntity *thisEnt, BOOL fromShaders);
 
 
static JSClass sVisualEffectClass =
{
    "VisualEffect",
    JSCLASS_HAS_PRIVATE,
    
    JS_PropertyStub,        // addProperty
    JS_PropertyStub,        // delProperty
    VisualEffectGetProperty,        // getProperty
    VisualEffectSetProperty,        // setProperty
    JS_EnumerateStub,       // enumerate
    JS_ResolveStub,         // resolve
    JS_ConvertStub,         // convert
    OOJSObjectWrapperFinalize,// finalize
    JSCLASS_NO_OPTIONAL_MEMBERS
};
 
 
enum
{
    // Property IDs
    kVisualEffect_beaconCode,
    kVisualEffect_beaconLabel,
    kVisualEffect_dataKey,
    kVisualEffect_hullHeatLevel,
    kVisualEffect_isBreakPattern,
    kVisualEffect_scaleX,
    kVisualEffect_scaleY,
    kVisualEffect_scaleZ,
    kVisualEffect_scannerDisplayColor1,
    kVisualEffect_scannerDisplayColor2,
    kVisualEffect_script,
    kVisualEffect_scriptInfo,
    kVisualEffect_shaderFloat1,
    kVisualEffect_shaderFloat2,
    kVisualEffect_shaderInt1,
    kVisualEffect_shaderInt2,
    kVisualEffect_shaderVector1,
    kVisualEffect_shaderVector2,
    kVisualEffect_subEntities,
    kVisualEffect_vectorForward,
    kVisualEffect_vectorRight,
    kVisualEffect_vectorUp
};
 
 
static JSPropertySpec sVisualEffectProperties[] =
{
    // JS name                      ID                                  flags
    { "beaconCode",    kVisualEffect_beaconCode,      OOJS_PROP_READWRITE_CB },
    { "beaconLabel",   kVisualEffect_beaconLabel,     OOJS_PROP_READWRITE_CB },
    { "dataKey",         kVisualEffect_dataKey,       OOJS_PROP_READONLY_CB },
    { "isBreakPattern", kVisualEffect_isBreakPattern,   OOJS_PROP_READWRITE_CB },
    { "scaleX", kVisualEffect_scaleX, OOJS_PROP_READWRITE_CB },
    { "scaleY", kVisualEffect_scaleY, OOJS_PROP_READWRITE_CB }, 
    { "scaleZ", kVisualEffect_scaleZ, OOJS_PROP_READWRITE_CB },
    { "scannerDisplayColor1", kVisualEffect_scannerDisplayColor1, OOJS_PROP_READWRITE_CB },
    { "scannerDisplayColor2", kVisualEffect_scannerDisplayColor2, OOJS_PROP_READWRITE_CB },
    { "hullHeatLevel", kVisualEffect_hullHeatLevel, OOJS_PROP_READWRITE_CB },
    { "script",              kVisualEffect_script,              OOJS_PROP_READONLY_CB },
    { "scriptInfo",      kVisualEffect_scriptInfo,      OOJS_PROP_READONLY_CB },
    { "shaderFloat1",  kVisualEffect_shaderFloat1,  OOJS_PROP_READWRITE_CB },
    { "shaderFloat2",  kVisualEffect_shaderFloat2,  OOJS_PROP_READWRITE_CB },
    { "shaderInt1",    kVisualEffect_shaderInt1,    OOJS_PROP_READWRITE_CB },
    { "shaderInt2",    kVisualEffect_shaderInt2,    OOJS_PROP_READWRITE_CB },
    { "shaderVector1", kVisualEffect_shaderVector1, OOJS_PROP_READWRITE_CB },
    { "shaderVector2", kVisualEffect_shaderVector2, OOJS_PROP_READWRITE_CB },
    { "subEntities",            kVisualEffect_subEntities,          OOJS_PROP_READONLY_CB },
    { "vectorForward", kVisualEffect_vectorForward, OOJS_PROP_READONLY_CB },
    { "vectorRight",     kVisualEffect_vectorRight,     OOJS_PROP_READONLY_CB },
    { "vectorUp",            kVisualEffect_vectorUp,            OOJS_PROP_READONLY_CB },
    { 0 }
};
 
 
static JSFunctionSpec sVisualEffectMethods[] =
{
    // JS name                  Function                        min args
    { "getMaterials",   VisualEffectGetMaterials,    0 },
    { "getShaders",     VisualEffectGetShaders,    0 },
    { "remove",         VisualEffectRemove,    0 },
    { "restoreSubEntities", VisualEffectRestoreSubEntities, 0 },
    { "scale",                VisualEffectScale, 1 },
    { "setMaterials",   VisualEffectSetMaterials,    1 },
    { "setShaders",     VisualEffectSetShaders,    2 },
 
    { 0 }
};
 
 
void InitOOJSVisualEffect(JSContext *context, JSObject *global)
{
    sVisualEffectPrototype = JS_InitClass(context, global, JSEntityPrototype(), &sVisualEffectClass, OOJSUnconstructableConstruct, 0, sVisualEffectProperties, sVisualEffectMethods, NULL, NULL);
    OOJSRegisterObjectConverter(&sVisualEffectClass, OOJSBasicPrivateObjectConverter);
    OOJSRegisterSubclass(&sVisualEffectClass, JSEntityClass());
}
 
 
static BOOL JSVisualEffectGetVisualEffectEntity(JSContext *context, JSObject *visualEffectObj, OOVisualEffectEntity **outEntity)
{
    OOJS_PROFILE_ENTER
    
    BOOL                        result;
    Entity                      *entity = nil;
    
    if (outEntity == NULL)  return NO;
    *outEntity = nil;
    
    result = OOJSEntityGetEntity(context, visualEffectObj, &entity);
    if (!result)  return NO;
    
    if (![entity isKindOfClass:[OOVisualEffectEntity class]])  return NO;
    
    *outEntity = (OOVisualEffectEntity *)entity;
    return YES;
    
    OOJS_PROFILE_EXIT
}
 
 
@implementation OOVisualEffectEntity (OOJavaScriptExtensions)
 
- (void)getJSClass:(JSClass **)outClass andPrototype:(JSObject **)outPrototype
{
    *outClass = &sVisualEffectClass;
    *outPrototype = sVisualEffectPrototype;
}
 
 
- (NSString *) oo_jsClassName
{
    return @"VisualEffect";
}
 
- (BOOL) isVisibleToScripts
{
    return YES;
}
 
- (NSArray *) subEntitiesForScript
{
    return [[self visualEffectSubEntityEnumerator] allObjects];
}
 
@end
 
 
static JSBool VisualEffectGetProperty(JSContext *context, JSObject *this, jsid propID, jsval *value)
{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    OOVisualEffectEntity                *entity = nil;
    id result = nil;
    
    if (!JSVisualEffectGetVisualEffectEntity(context, this, &entity))  return NO;
    if (entity == nil)  { *value = JSVAL_VOID; return YES; }
    
    switch (JSID_TO_INT(propID))
    {
        case kVisualEffect_beaconCode:
            result = [entity beaconCode];
            break;
 
        case kVisualEffect_beaconLabel:
            result = [entity beaconLabel];
            break;
 
        case kVisualEffect_dataKey:
            result = [entity effectKey];
            break;
 
        case kVisualEffect_isBreakPattern:
            *value = OOJSValueFromBOOL([entity isBreakPattern]);
 
            return YES;
 
        case kVisualEffect_vectorRight:
            return VectorToJSValue(context, [entity rightVector], value);
            
        case kVisualEffect_vectorForward:
            return VectorToJSValue(context, [entity forwardVector], value);
            
        case kVisualEffect_vectorUp:
            return VectorToJSValue(context, [entity upVector], value);
 
        case kVisualEffect_scaleX:
            return JS_NewNumberValue(context, [entity scaleX], value);
 
        case kVisualEffect_scaleY:
            return JS_NewNumberValue(context, [entity scaleY], value);
 
        case kVisualEffect_scaleZ:
            return JS_NewNumberValue(context, [entity scaleZ], value);
 
        case kVisualEffect_scannerDisplayColor1:
            result = [[entity scannerDisplayColor1] normalizedArray];
            break;
            
        case kVisualEffect_scannerDisplayColor2:
            result = [[entity scannerDisplayColor2] normalizedArray];
            break;
 
        case kVisualEffect_hullHeatLevel:
            return JS_NewNumberValue(context, [entity hullHeatLevel], value);
 
        case kVisualEffect_shaderFloat1:
            return JS_NewNumberValue(context, [entity shaderFloat1], value);
 
        case kVisualEffect_shaderFloat2:
            return JS_NewNumberValue(context, [entity shaderFloat2], value);
 
        case kVisualEffect_shaderInt1:
            *value = INT_TO_JSVAL([entity shaderInt1]);
            return YES;
 
        case kVisualEffect_shaderInt2:
            *value = INT_TO_JSVAL([entity shaderInt2]);
            return YES;
 
        case kVisualEffect_shaderVector1:
            return VectorToJSValue(context, [entity shaderVector1], value);
 
        case kVisualEffect_shaderVector2:
            return VectorToJSValue(context, [entity shaderVector2], value);
 
        case kVisualEffect_subEntities:
            result = [entity subEntitiesForScript];
            break;
            
            
        case kVisualEffect_script:
            result = [entity script];
            break;
 
        case kVisualEffect_scriptInfo:
            result = [entity scriptInfo];
            if (result == nil)  result = [NSDictionary dictionary]; // empty rather than null
            break;
 
        default:
            OOJSReportBadPropertySelector(context, this, propID, sVisualEffectProperties);
            return NO;
    }
 
    *value = OOJSValueFromNativeObject(context, result);
    return YES;
    
    OOJS_NATIVE_EXIT
}
 
 
static JSBool VisualEffectSetProperty(JSContext *context, JSObject *this, jsid propID, JSBool strict, jsval *value)
{
    if (!JSID_IS_INT(propID))  return YES;
    
    OOJS_NATIVE_ENTER(context)
    
    OOVisualEffectEntity                *entity = nil;
    JSBool                      bValue;
    OOColor *colorForScript;
    int32                       iValue;
    jsdouble        fValue;
    Vector          vValue;
    NSString                    *sValue = nil;
 
    
    if (!JSVisualEffectGetVisualEffectEntity(context, this, &entity)) return NO;
    if (entity == nil)  return YES;
    
    switch (JSID_TO_INT(propID))
    {
        case kVisualEffect_beaconCode:
            sValue = OOStringFromJSValue(context,*value);
            if (sValue == nil || [sValue length] == 0) 
            {
                if ([entity isBeacon]) 
                {
                    [UNIVERSE clearBeacon:entity];
                    if ([PLAYER nextBeacon] == entity)
                    {
                        [PLAYER setCompassMode:COMPASS_MODE_PLANET];
                    }
                }
            }
            else 
            {
                if ([entity isBeacon]) 
                {
                    [entity setBeaconCode:sValue];
                }
                else // Universe needs to update beacon lists in this case only
                {
                    [entity setBeaconCode:sValue];
                    [UNIVERSE setNextBeacon:entity];
                }
            }
            return YES;
            break;
 
        case kVisualEffect_beaconLabel:
            sValue = OOStringFromJSValue(context,*value);
            if (sValue != nil)
            {
                [entity setBeaconLabel:sValue];
                return YES;
            }
            break;
 
        case kVisualEffect_isBreakPattern:
            if (JS_ValueToBoolean(context, *value, &bValue))
            {
                [entity setIsBreakPattern:bValue];
                return YES;
            }
            break;
 
        case kVisualEffect_scannerDisplayColor1:
            colorForScript = [OOColor colorWithDescription:OOJSNativeObjectFromJSValue(context, *value)];
            if (colorForScript != nil || JSVAL_IS_NULL(*value))
            {
                [entity setScannerDisplayColor1:colorForScript];
                return YES;
            }
            break;
            
        case kVisualEffect_scannerDisplayColor2:
            colorForScript = [OOColor colorWithDescription:OOJSNativeObjectFromJSValue(context, *value)];
            if (colorForScript != nil || JSVAL_IS_NULL(*value))
            {
                [entity setScannerDisplayColor2:colorForScript];
                return YES;
            }
            break;
 
        case kVisualEffect_scaleX:
            if (JS_ValueToNumber(context, *value, &fValue))
            {
                if (fValue > 0.0)
                {
                    [entity setScaleX:fValue];
                    return YES;
                }
            }
            break;
 
        case kVisualEffect_scaleY:
            if (JS_ValueToNumber(context, *value, &fValue))
            {
                if (fValue > 0.0)
                {
                    [entity setScaleY:fValue];
                    return YES;
                }
            }
            break;
 
        case kVisualEffect_scaleZ:
            if (JS_ValueToNumber(context, *value, &fValue))
            {
                if (fValue > 0.0)
                {
                    [entity setScaleZ:fValue];
                    return YES;
                }
            }
            break;
 
        case kVisualEffect_hullHeatLevel:
            if (JS_ValueToNumber(context, *value, &fValue))
            {
                [entity setHullHeatLevel:fValue];
                return YES;
            }
            break;
 
        case kVisualEffect_shaderFloat1:
            if (JS_ValueToNumber(context, *value, &fValue))
            {
                [entity setShaderFloat1:fValue];
                return YES;
            }
            break;
 
        case kVisualEffect_shaderFloat2:
            if (JS_ValueToNumber(context, *value, &fValue))
            {
                [entity setShaderFloat2:fValue];
                return YES;
            }
            break;
 
        case kVisualEffect_shaderInt1:
            if (JS_ValueToInt32(context, *value, &iValue))
            {
                [entity setShaderInt1:iValue];
                return YES;
            }
            break;
 
        case kVisualEffect_shaderInt2:
            if (JS_ValueToInt32(context, *value, &iValue))
            {
                [entity setShaderInt2:iValue];
                return YES;
            }
            break;
 
        case kVisualEffect_shaderVector1:
            if (JSValueToVector(context, *value, &vValue))
            {
                [entity setShaderVector1:vValue];
                return YES;
            }
            break;
 
        case kVisualEffect_shaderVector2:
            if (JSValueToVector(context, *value, &vValue))
            {
                [entity setShaderVector2:vValue];
                return YES;
            }
            break;
 
        default:
            OOJSReportBadPropertySelector(context, this, propID, sVisualEffectProperties);
            return NO;
    }
    
    OOJSReportBadPropertyValue(context, this, propID, sVisualEffectProperties, *value);
    return NO;
    
    OOJS_NATIVE_EXIT
}
 
 
// *** Methods ***
 
#define GET_THIS_EFFECT(THISENT) do { \
    if (EXPECT_NOT(!JSVisualEffectGetVisualEffectEntity(context, OOJS_THIS, &THISENT)))  return NO; /* Exception */ \
    if (OOIsStaleEntity(THISENT))  OOJS_RETURN_VOID; \
} while (0)
 
 
static JSBool VisualEffectRemove(JSContext *context, uintN argc, jsval *vp)
{
    OOJS_NATIVE_ENTER(context)
    
    OOVisualEffectEntity                *thisEnt = nil;
    GET_THIS_EFFECT(thisEnt);
    
    if ([thisEnt isSubEntity])
    {
        OOVisualEffectEntity                *parent = [thisEnt owner];
        [parent removeSubEntity:thisEnt];
    }
    else
    {
        [thisEnt remove];
    }
 
    OOJS_RETURN_VOID;
    
    OOJS_NATIVE_EXIT
}
 
 
//getMaterials()
static JSBool VisualEffectGetMaterials(JSContext *context, uintN argc, jsval *vp)
{
    OOJS_PROFILE_ENTER
 
    NSObject            *result = nil;
    OOVisualEffectEntity                *thisEnt = nil;
 
    GET_THIS_EFFECT(thisEnt);
    
    result = [[thisEnt mesh] materials];
    if (result == nil)  result = [NSDictionary dictionary];
    OOJS_RETURN_OBJECT(result);
    
    OOJS_PROFILE_EXIT
}
 
//getShaders()
static JSBool VisualEffectGetShaders(JSContext *context, uintN argc, jsval *vp)
{
    OOJS_PROFILE_ENTER
    
    NSObject            *result = nil;
    OOVisualEffectEntity                *thisEnt = nil;
 
    GET_THIS_EFFECT(thisEnt);
    
    result = [[thisEnt mesh] shaders];
    if (result == nil)  result = [NSDictionary dictionary];
    OOJS_RETURN_OBJECT(result);
    
    OOJS_PROFILE_EXIT
}
 
 
// setMaterials(params: dict, [shaders: dict])  // sets materials dictionary. Optional parameter sets the shaders dictionary too.
static JSBool VisualEffectSetMaterials(JSContext *context, uintN argc, jsval *vp)
{
    OOJS_NATIVE_ENTER(context)
    
    OOVisualEffectEntity                *thisEnt = nil;
    
    if (argc < 1)
    {
        OOJSReportBadArguments(context, @"VisualEffect", @"setMaterials", 0, OOJS_ARGV, nil, @"parameter object");
        return NO;
    }
    
    GET_THIS_EFFECT(thisEnt);
    
    return VisualEffectSetMaterialsInternal(context, argc, vp, thisEnt, NO);
    
    OOJS_NATIVE_EXIT
}
 
 
// setShaders(params: dict) 
static JSBool VisualEffectSetShaders(JSContext *context, uintN argc, jsval *vp)
{
    OOJS_NATIVE_ENTER(context)
    
    OOVisualEffectEntity                *thisEnt = nil;
    
    GET_THIS_EFFECT(thisEnt);
    
    if (argc < 1)
    {
        OOJSReportBadArguments(context, @"VisualEffect", @"setShaders", 0, OOJS_ARGV, nil, @"parameter object");
        return NO;
    }
    
    if (JSVAL_IS_NULL(OOJS_ARGV[0]) || (!JSVAL_IS_NULL(OOJS_ARGV[0]) && !JSVAL_IS_OBJECT(OOJS_ARGV[0])))
    {
        // EMMSTRAN: JS_ValueToObject() and normal error handling here.
        OOJSReportWarning(context, @"VisualEffect.%@: expected %@ instead of '%@'.", @"setShaders", @"object", OOStringFromJSValueEvenIfNull(context, OOJS_ARGV[0]));
        OOJS_RETURN_BOOL(NO);
    }
    
    OOJS_ARGV[1] = OOJS_ARGV[0];
    return VisualEffectSetMaterialsInternal(context, argc, vp, thisEnt, YES);
    
    OOJS_NATIVE_EXIT
}
 
 
 
 
 
/* **  helper functions ** */
 
static JSBool VisualEffectSetMaterialsInternal(JSContext *context, uintN argc, jsval *vp, OOVisualEffectEntity *thisEnt, BOOL fromShaders)
{
    OOJS_PROFILE_ENTER
    
    JSObject                *params = NULL;
    NSDictionary            *materials;
    NSDictionary            *shaders;
    BOOL                    withShaders = NO;
    BOOL                    success = NO;
    
    GET_THIS_EFFECT(thisEnt);
    
    if (JSVAL_IS_NULL(OOJS_ARGV[0]) || (!JSVAL_IS_NULL(OOJS_ARGV[0]) && !JSVAL_IS_OBJECT(OOJS_ARGV[0])))
    {
        OOJSReportWarning(context, @"VisualEffect.%@: expected %@ instead of '%@'.", @"setMaterials", @"object", OOStringFromJSValueEvenIfNull(context, OOJS_ARGV[0]));
        OOJS_RETURN_BOOL(NO);
    }
    
    if (argc > 1)
    {
        withShaders = YES;
        if (JSVAL_IS_NULL(OOJS_ARGV[1]) || (!JSVAL_IS_NULL(OOJS_ARGV[1]) && !JSVAL_IS_OBJECT(OOJS_ARGV[1])))
        {
            OOJSReportWarning(context, @"VisualEffect.%@: expected %@ instead of '%@'.",  @"setMaterials", @"object as second parameter", OOStringFromJSValueEvenIfNull(context, OOJS_ARGV[1]));
            withShaders = NO;
        }
    }
    
    if (fromShaders)
    {
        materials = [[thisEnt mesh] materials];
        params = JSVAL_TO_OBJECT(OOJS_ARGV[0]);
        shaders = OOJSNativeObjectFromJSObject(context, params);
    }
    else
    {
        params = JSVAL_TO_OBJECT(OOJS_ARGV[0]);
        materials = OOJSNativeObjectFromJSObject(context, params);
        if (withShaders)
        {
            params = JSVAL_TO_OBJECT(OOJS_ARGV[1]);
            shaders = OOJSNativeObjectFromJSObject(context, params);
        }
        else
        {
            shaders = [[thisEnt mesh] shaders];
        }
    }
    
    OOJS_BEGIN_FULL_NATIVE(context)
    NSDictionary            *effectDict = [thisEnt effectInfoDictionary];
    
    // First we test to see if we can create the mesh.
    OOMesh *mesh = [OOMesh meshWithName:[effectDict oo_stringForKey:@"model"]
                               cacheKey:nil
                     materialDictionary:materials
                      shadersDictionary:shaders
                                 smooth:[effectDict oo_boolForKey:@"smooth" defaultValue:NO]
                           shaderMacros:[[ResourceManager materialDefaults] oo_dictionaryForKey:@"ship-prefix-macros"]
                    shaderBindingTarget:thisEnt];
    
    if (mesh != nil)
    {
        [thisEnt setMesh:mesh];
        success = YES;
    }
    OOJS_END_FULL_NATIVE
    
    OOJS_RETURN_BOOL(success);
    
    OOJS_PROFILE_EXIT
}
 
static JSBool VisualEffectScale(JSContext *context, uintN argc, jsval *vp)
{
    OOJS_NATIVE_ENTER(context)
 
    OOVisualEffectEntity *thisEnt = nil;
    GET_THIS_EFFECT(thisEnt);
    jsdouble scale;
    BOOL gotScale;
 
    if (argc < 1)
    {
        OOJSReportBadArguments(context, @"VisualEffect", @"scale", argc, OOJS_ARGV, nil, @"scale factor needed");
        return NO;
    }
 
    gotScale = JS_ValueToNumber(context, OOJS_ARGV[0], &scale);
    if (EXPECT_NOT(scale <= 0.0 || !gotScale))
    {
        OOJSReportBadArguments(context, @"VisualEffect", @"scale", argc, OOJS_ARGV, nil, @"scale factor must be positive");
        return NO;
    }
 
    // set all three scales
    [thisEnt setScaleX:scale];
    [thisEnt setScaleY:scale];
    [thisEnt setScaleZ:scale];
 
    return YES;
    OOJS_NATIVE_EXIT
        
} 
 
 
// restoreSubEntities(): boolean
static JSBool VisualEffectRestoreSubEntities(JSContext *context, uintN argc, jsval *vp)
{
    OOJS_NATIVE_ENTER(context)
    
    OOVisualEffectEntity                *thisEnt = nil;
    NSUInteger              numSubEntitiesRestored = 0U;
    
    GET_THIS_EFFECT(thisEnt);
    
    NSUInteger subCount = [[thisEnt subEntitiesForScript] count];
    
    [thisEnt clearSubEntities];
    [thisEnt setUpSubEntities];
    
    if ([[thisEnt subEntitiesForScript] count] - subCount > 0)  numSubEntitiesRestored = [[thisEnt subEntitiesForScript] count] - subCount;
    
    OOJS_RETURN_BOOL(numSubEntitiesRestored > 0);
    
    OOJS_NATIVE_EXIT
}