OOJSVector.h

Go to the documentation of this file.

/*
 
OOJSVector.h
 
JavaScript proxy for vectors.
 
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 <Foundation/Foundation.h>
#include <jsapi.h>
#import "OOMaths.h"
 
 
void InitOOJSVector(JSContext *context, JSObject *global);
 
 
JSObject *JSVectorWithVector(JSContext *context, Vector vector)  NONNULL_FUNC;
JSObject *JSVectorWithHPVector(JSContext *context, HPVector vector)  NONNULL_FUNC;
 
BOOL VectorToJSValue(JSContext *context, Vector vector, jsval *outValue)  NONNULL_FUNC;
BOOL HPVectorToJSValue(JSContext *context, HPVector vector, jsval *outValue)  NONNULL_FUNC;
BOOL NSPointToVectorJSValue(JSContext *context, NSPoint point, jsval *outValue)  NONNULL_FUNC;
BOOL JSValueToVector(JSContext *context, jsval value, Vector *outVector)  NONNULL_FUNC;
BOOL JSValueToHPVector(JSContext *context, jsval value, HPVector *outVector)  NONNULL_FUNC;
 
/*  Given a JS Vector object, get the corresponding Vector struct. Given a JS
    Entity, get its position. Given a JS Array with exactly three elements,
    all of them numbers, treat them as [x, y, z]  components. For anything
    else, return NO. (Other implicit conversions may be added in future.)
*/
BOOL JSObjectGetVector(JSContext *context, JSObject *vectorObj, HPVector *outVector)  GCC_ATTR((nonnull (1, 3)));
 
//  Set the value of a JS vector object.
BOOL JSVectorSetVector(JSContext *context, JSObject *vectorObj, Vector vector)  GCC_ATTR((nonnull (1)));
BOOL JSVectorSetHPVector(JSContext *context, JSObject *vectorObj, HPVector vector)  GCC_ATTR((nonnull (1)));
 
 
/*  VectorFromArgumentList()
    
    Construct a vector from an argument list which is either a (JS) vector, a
    (JS) entity, or an array of three numbers. The optional outConsumed
    argument can be used to find out how many parameters were used
    (currently, this will be 0 on failure, otherwise 1).
    
    On failure, it will return NO and raise an error. If the caller is a JS
    callback, it must return NO to signal an error.
    
    DEPRECATED in favour of JSObjectGetVector(), since the list-of-number form
    is no longer used.
*/
BOOL VectorFromArgumentList(JSContext *context, NSString *scriptClass, NSString *function, uintN argc, jsval *argv, HPVector *outVector, uintN *outConsumed)  GCC_ATTR((nonnull (1, 5, 6)));
 
/*  VectorFromArgumentListNoError()
    
    Like VectorFromArgumentList(), but does not report an error on failure.
*/
BOOL VectorFromArgumentListNoError(JSContext *context, uintN argc, jsval *argv, HPVector *outVector, uintN *outConsumed)  GCC_ATTR((nonnull (1, 3, 4)));