BNBParameter

Objective-C

@interface BNBParameter : NSObject

/**
 *Fabric method for parameter creating.
 *@param name (string): parameter name.
 *@return created parameter (parameter)
 */
+ (nullable BNBParameter *)create:(nonnull NSString *)name;

/**@return parameter name (string) */
- (nonnull NSString *)getName;

/**
 *set parameter integer value.
 *@param value (int)
 */
- (void)setInteger:(int32_t)value;

/**return parameter int value. Throw is type is not equal type, which was added earlier. */
- (int32_t)getInteger;

/**
 *set parameter real value.
 *@param value (float)
 */
- (void)setReal:(float)value;

/**return parameter f32 value. Throw is type is not equal type, which was added earlier. */
- (float)getReal;

/**
 *set x of vec3/vec4 value only.
 *@param value (f32)
 */
- (void)setX:(float)value;

/**
 *set y of vec3/vec4 value only.
 *@param value (f32)
 */
- (void)setY:(float)value;

/**
 *set z of vec3/vec4 value only.
 *@param value (f32)
 */
- (void)setZ:(float)value;

/**
 *set w of vec4 value only.
 *@param value (f32)
 */
- (void)setW:(float)value;

/**
 *set parameter vec3 value.
 *@param value (vec3)
 */
- (void)setVector3:(nonnull BNBVec3 *)value;

/**return parameter vec3 value. Throw is type is not equal type, which was added earlier. */
- (nonnull BNBVec3 *)getVector3;

/**
 *set parameter vec4 value.
 *@param value (vec4)
 */
- (void)setVector4:(nonnull BNBVec4 *)value;

/**return parameter vec4 value. Throw is type is not equal type, which was added earlier. */
- (nonnull BNBVec4 *)getVector4;

/**
 *set parameter mat2x4 value.
 *@param value (mat2x4)
 */
- (void)setMat2x4:(nonnull BNBMat2x4 *)value;

/**return parameter mat2x4 value. Throw is type is not equal type, which was added earlier. */
- (nonnull BNBMat2x4 *)getMat2x4;

/**
 *set parameter mat3x4 value.
 *@param value (mat3x4)
 */
- (void)setMat3x4:(nonnull BNBMat3x4 *)value;

/**return parameter mat3x4 value. Throw is type is not equal type, which was added earlier. */
- (nonnull BNBMat3x4 *)getMat3x4;

/**
 *set parameter mat4x4 value.
 *@param value (mat4x4)
 */
- (void)setMat4x4:(nonnull BNBMat4x4 *)value;

/**return parameter mat4x4 value. Throw is type is not equal type, which was added earlier. */
- (nonnull BNBMat4x4 *)getMat4x4;

@end

Swift

class BNBParameter : NSObject

Undocumented

  • Fabric method for parameter creating.

    Declaration

    Objective-C

    + (nullable BNBParameter *)create:(nonnull NSString *)name;

    Swift

    class func create(_ name: String) -> BNBParameter?

    Parameters

    name

    (string): parameter name.

    Return Value

    created parameter (parameter)

  • Declaration

    Objective-C

    - (nonnull NSString *)getName;

    Swift

    func getName() -> String

    Return Value

    parameter name (string)

  • set parameter integer value.

    Declaration

    Objective-C

    - (void)setInteger:(int32_t)value;

    Swift

    func setInteger(_ value: Int32)

    Parameters

    value

    (int)

  • return parameter int value. Throw is type is not equal type, which was added earlier.

    Declaration

    Objective-C

    - (int32_t)getInteger;

    Swift

    func getInteger() -> Int32
  • set parameter real value.

    Declaration

    Objective-C

    - (void)setReal:(float)value;

    Swift

    func setReal(_ value: Float)

    Parameters

    value

    (float)

  • return parameter f32 value. Throw is type is not equal type, which was added earlier.

    Declaration

    Objective-C

    - (float)getReal;

    Swift

    func getReal() -> Float
  • set x of vec3/vec4 value only.

    Declaration

    Objective-C

    - (void)setX:(float)value;

    Swift

    func setX(_ value: Float)

    Parameters

    value

    (f32)

  • set y of vec3/vec4 value only.

    Declaration

    Objective-C

    - (void)setY:(float)value;

    Swift

    func setY(_ value: Float)

    Parameters

    value

    (f32)

  • set z of vec3/vec4 value only.

    Declaration

    Objective-C

    - (void)setZ:(float)value;

    Swift

    func setZ(_ value: Float)

    Parameters

    value

    (f32)

  • set w of vec4 value only.

    Declaration

    Objective-C

    - (void)setW:(float)value;

    Swift

    func setW(_ value: Float)

    Parameters

    value

    (f32)

  • set parameter vec3 value.

    Declaration

    Objective-C

    - (void)setVector3:(nonnull BNBVec3 *)value;

    Swift

    func setVector3(_ value: BNBVec3)

    Parameters

    value

    (vec3)

  • return parameter vec3 value. Throw is type is not equal type, which was added earlier.

    Declaration

    Objective-C

    - (nonnull BNBVec3 *)getVector3;

    Swift

    func getVector3() -> BNBVec3
  • set parameter vec4 value.

    Declaration

    Objective-C

    - (void)setVector4:(nonnull BNBVec4 *)value;

    Swift

    func setVector4(_ value: BNBVec4)

    Parameters

    value

    (vec4)

  • return parameter vec4 value. Throw is type is not equal type, which was added earlier.

    Declaration

    Objective-C

    - (nonnull BNBVec4 *)getVector4;

    Swift

    func getVector4() -> BNBVec4
  • set parameter mat2x4 value.

    Declaration

    Objective-C

    - (void)setMat2x4:(nonnull BNBMat2x4 *)value;

    Swift

    func setMat2x4(_ value: BNBMat2x4)

    Parameters

    value

    (mat2x4)

  • return parameter mat2x4 value. Throw is type is not equal type, which was added earlier.

    Declaration

    Objective-C

    - (nonnull BNBMat2x4 *)getMat2x4;

    Swift

    func getMat2x4() -> BNBMat2x4
  • set parameter mat3x4 value.

    Declaration

    Objective-C

    - (void)setMat3x4:(nonnull BNBMat3x4 *)value;

    Swift

    func setMat3x4(_ value: BNBMat3x4)

    Parameters

    value

    (mat3x4)

  • return parameter mat3x4 value. Throw is type is not equal type, which was added earlier.

    Declaration

    Objective-C

    - (nonnull BNBMat3x4 *)getMat3x4;

    Swift

    func getMat3x4() -> BNBMat3x4
  • set parameter mat4x4 value.

    Declaration

    Objective-C

    - (void)setMat4x4:(nonnull BNBMat4x4 *)value;

    Swift

    func setMat4x4(_ value: BNBMat4x4)

    Parameters

    value

    (mat4x4)

  • return parameter mat4x4 value. Throw is type is not equal type, which was added earlier.

    Declaration

    Objective-C

    - (nonnull BNBMat4x4 *)getMat4x4;

    Swift

    func getMat4x4() -> BNBMat4x4