vvopensource
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Instance Methods
ISFAttrib Class Reference

internally, an ISFGLScene creates an ISFAttrib for each of the declared inputs in an ISF file. if you query an ISFGLScene's inputs- for introspection, for example- you'll get an array of ISFAttribs, which can be examined to learn more about the nature of the input More...

#import <ISFAttrib.h>

Inherits NSObject.

Instance Methods

(NSString *) - attribName
 returns the name of the attribute- the name of the attribute is also the variable name in the source!
 
(NSString *) - attribDescription
 returns the description of the attribute (from the JSON blob) as an NSString
 
(NSString *) - attribLabel
 returns the label of the attribute (from the JSON blob) as an NSString
 
(ISFAttribValType- attribType
 returns an ISFAttribValType describing what type of attribute this is (what kind of value/input it is)
 
(ISFAttribVal- currentVal
 returns the current value of this attribute. not useful if this is an image attribute- if this is an image attribute, the most recently-stored VVBuffer is stored in its userInfo!
 
(void) - setCurrentVal:
 copies the appropriate value from the union, based on the type of this attribute
 
(ISFAttribVal- minVal
 returns a union describing this attribute's min val
 
(ISFAttribVal- maxVal
 returns a union describing this attribute's max val
 
(ISFAttribVal- defaultVal
 returns a union describing this attribute's default val
 
(ISFAttribVal- identityVal
 returns a union describing this attribute's identity val
 
(NSMutableArray *) - labelArray
 only used if this is an ISFAT_Long-type attribute- returns an array containing labels (NSStrings) for each of the input values
 
(NSMutableArray *) - valArray
 only used if this is an ISFAT_Long-type attribute- returns an array containing values (NSNumbers) for each of the input values
 
(BOOL) - isFilterInputImage
 returns a YES if this attribute describes the default input for an image filter
 
(void) - setUserInfo:
 the userInfo is an arbitrary id that gets retained with the attribute- if this is an ISFAT_Image, then this is probably used to store a VVBuffer with the current value
 
(id) - userInfo
 returns the userInfo, an arbitrary id retained with this attribute
 

Detailed Description

internally, an ISFGLScene creates an ISFAttrib for each of the declared inputs in an ISF file. if you query an ISFGLScene's inputs- for introspection, for example- you'll get an array of ISFAttribs, which can be examined to learn more about the nature of the input


The documentation for this class was generated from the following files: