ISFAttrib.h

Go to the documentation of this file.

#import <Cocoa/Cocoa.h>





typedef enum    {
    ISFAT_Event,    
    ISFAT_Bool, 
    ISFAT_Long, 
    ISFAT_Float,    
    ISFAT_Point2D,  
    ISFAT_Color,    
    ISFAT_Image 
} ISFAttribValType;

typedef union ISFAttribVal  {
    BOOL            eventVal;       
    BOOL            boolVal;    
    long            longVal;    
    GLfloat         floatVal;   
    GLfloat         point2DVal[2];  
    GLfloat         colorVal[4];    
    long            imageVal;   
} ISFAttribVal;





@interface ISFAttrib : NSObject {
    NSString                *attribName;
    NSString                *attribDescription;
    NSString                *attribLabel;
    ISFAttribValType    attribType;
    ISFAttribVal        currentVal;
    ISFAttribVal        minVal;
    ISFAttribVal        maxVal;
    ISFAttribVal        defaultVal;
    ISFAttribVal        identityVal;
    NSMutableArray          *labelArray;    //  only used if it's a LONG. array containing NSStrings that correspond to the values in "valArray"
    NSMutableArray          *valArray;  //  only used if it's a LONG. array containing NSNumbers with the values that correspond to the accompanying labels
    BOOL                    isFilterInputImage; //  if YES, this is an image-type input and is the main input for an image filter
    id                      userInfo;   //  retained- used to retain an NSObject-based GL resource for the lifetime of the input (retains an image for image attributes)
    int                     uniformLocation[4]; //  the location of this attribute in the compiled GLSL program. cached here because lookup times are costly when performed every frame.  there are 4 because images require four uniforms (one of the texture name, one for the size, one for the img rect, and one for the flippedness)
}

//  creating attributes isn't really covered in the published documentation because you probably shouldn't be doing it from outside the framework.
+ (id) createWithName:(NSString *)n description:(NSString *)desc label:(NSString *)l type:(ISFAttribValType)t values:(ISFAttribVal)min :(ISFAttribVal) max :(ISFAttribVal)def :(ISFAttribVal)iden :(NSArray *)lArray :(NSArray *)vArray;
- (id) initWithName:(NSString *)n description:(NSString *)desc label:(NSString *)l type:(ISFAttribValType)t values:(ISFAttribVal)min :(ISFAttribVal) max :(ISFAttribVal)def :(ISFAttribVal)iden :(NSArray *)lArray :(NSArray *)vArray;

- (NSString *) attribName;
- (NSString *) attribDescription;
- (NSString *) attribLabel;
- (ISFAttribValType) attribType;

- (ISFAttribVal) currentVal;
- (void) setCurrentVal:(ISFAttribVal)n;
- (ISFAttribVal) minVal;
- (ISFAttribVal) maxVal;
- (ISFAttribVal) defaultVal;
- (ISFAttribVal) identityVal;
- (NSMutableArray *) labelArray;
- (NSMutableArray *) valArray;

- (void) setIsFilterInputImage:(BOOL)n;
- (BOOL) isFilterInputImage;

- (void) setUserInfo:(id)n;
- (id) userInfo;
- (void) setUniformLocation:(int)n forIndex:(int)i;
- (int) uniformLocationForIndex:(int)i;
- (void) clearUniformLocations;

@end