SKUSliderButton

Introduction

Cross platform solution for basic sliders.

Slider Inits

Group members:

Slider Looks

Slider Actions

Group members:

Methods

+defaults:

sliderButtonWithDefaults

-setChangedAction:toPerformOnTarget:

+sliderButtonWithKnobPackage:

+sliderButtonWithSliderPackage:andKnobPackage:

defaults:

sliderButtonWithDefaults

+(SKUSliderButton*)sliderButtonWithDefaults NS_SWIFT_NAME(init(
                defaults:)); 

Return Value

new SKUSliderButton object

Discussion

Creates and returns an SKUSliderButton with default settings.

setChangedAction:toPerformOnTarget:

-(void)setChangedAction:(SEL)selector toPerformOnTarget:(NSObject*)target; 

Discussion

If button is set to call actions, set method and target to call on method when value changed. Sets flag on self.buttonMethods to run actions.

sliderButtonWithKnobPackage:

+(SKUSliderButton*)sliderButtonWithKnobPackage:(SKUButtonSpriteStatePropertiesPackage*)knobPackage; 

Parameters

Return Value

new SKUSliderButton object

Discussion

Creates and returns an SKUSliderButton with packages provided.

sliderButtonWithSliderPackage:andKnobPackage:

+(SKUSliderButton*)sliderButtonWithSliderPackage:(SKUButtonSpriteStatePropertiesPackage*)sliderPackage 
        andKnobPackage:(SKUButtonSpriteStatePropertiesPackage*)knobPackage; 

Parameters

Return Value

new SKUSliderButton object

Discussion

Creates and returns an SKUSliderButton with packages provided.

Properties

continuous

knobSprite

knobSpritePropertiesDefault

knobSpritePropertiesDisabled

knobSpritePropertiesHovered

knobSpritePropertiesPressed

maximumValue

maximumValueImage

maximumValueImagePropertiesDefault

maximumValueImagePropertiesDisabled

minimumValue

minimumValueImage

minimumValueImagePropertiesDefault

minimumValueImagePropertiesDisabled

notificationNameChanged

previousValue

sliderWidth

slideSprite

slideSpritePropertiesDefault

slideSpritePropertiesDisabled

slideSpritePropertiesHovered

slideSpritePropertiesPressed

stepSize

value

continuous

@property (nonatomic) BOOL continuous; 

Discussion

Defaults to NO.

knobSprite

@property (nonatomic,
    strong,
    readonly) SKSpriteNode* knobSprite; 

Discussion

Read only access to knob sprite.

knobSpritePropertiesDefault

@property (nonatomic) SKUButtonSpriteStateProperties* knobSpritePropertiesDefault; 

Discussion

Properties to use on the knob sprite in default state.

knobSpritePropertiesDisabled

@property (nonatomic) SKUButtonSpriteStateProperties* knobSpritePropertiesDisabled; 

Discussion

Properties to use on the knob sprite in disabled state.

knobSpritePropertiesHovered

@property (nonatomic) SKUButtonSpriteStateProperties* knobSpritePropertiesHovered; 

Discussion

Properties to use on the knob sprite in hovered state.

knobSpritePropertiesPressed

@property (nonatomic) SKUButtonSpriteStateProperties* knobSpritePropertiesPressed; 

Discussion

Properties to use on the knob sprite in pressed state.

maximumValue

@property (nonatomic) CGFloat maximumValue; 

Discussion

Defaults to 100.0.

maximumValueImage

@property (nonatomic,
    strong,
    readonly) SKSpriteNode* maximumValueImage; 

Discussion

Read only access to maximumValueImage sprite.

maximumValueImagePropertiesDefault

@property (nonatomic) SKUButtonSpriteStateProperties* maximumValueImagePropertiesDefault; 

Discussion

Properties to use on the maximumValueImage sprite in default state.

maximumValueImagePropertiesDisabled

@property (nonatomic) SKUButtonSpriteStateProperties* maximumValueImagePropertiesDisabled; 

Discussion

Properties to use on the maximumValueImage sprite in disabled state.

minimumValue

@property (nonatomic) CGFloat minimumValue; 

Discussion

Defaults to 0.0.

minimumValueImage

@property (nonatomic,
    strong,
    readonly) SKSpriteNode* minimumValueImage; 

Discussion

Read only access to minimumValueImage sprite.

minimumValueImagePropertiesDefault

@property (nonatomic) SKUButtonSpriteStateProperties* minimumValueImagePropertiesDefault; 

Discussion

Properties to use on the minimumValueImage sprite in default state.

minimumValueImagePropertiesDisabled

@property (nonatomic) SKUButtonSpriteStateProperties* minimumValueImagePropertiesDisabled; 

Discussion

Properties to use on the minimumValueImage sprite in disabled state.

notificationNameChanged

@property (nonatomic) NSString* notificationNameChanged; 

Discussion

If button is set to send notifications, this is the name of the notification when the value changes.

previousValue

@property (nonatomic,
    readonly) CGFloat previousValue; 

Discussion

Stores the previous value.

sliderWidth

@property (nonatomic) CGFloat sliderWidth; 

Discussion

Defaults to 200.0.

slideSprite

@property (nonatomic,
    strong,
    readonly) SKSpriteNode* slideSprite; 

Discussion

Read only access to slide sprite.

slideSpritePropertiesDefault

@property (nonatomic) SKUButtonSpriteStateProperties* slideSpritePropertiesDefault; 

Discussion

Properties to use on the slide sprite in default state.

slideSpritePropertiesDisabled

@property (nonatomic) SKUButtonSpriteStateProperties* slideSpritePropertiesDisabled; 

Discussion

Properties to use on the slide sprite in disabled state.

slideSpritePropertiesHovered

@property (nonatomic) SKUButtonSpriteStateProperties* slideSpritePropertiesHovered; 

Discussion

Properties to use on the slide sprite in hovered state.

slideSpritePropertiesPressed

@property (nonatomic) SKUButtonSpriteStateProperties* slideSpritePropertiesPressed; 

Discussion

Properties to use on the slide sprite in pressed state.

stepSize

@property (nonatomic) CGFloat stepSize; 

Discussion

Step value to increment (modified by speed of movement) or decrement the value by when sliding with a Siri Remote. This is not required as a value is generated on the fly, but is available for customization. Uses auto generated value if the value is 0. Default value is 0. Harmless to use on other platforms, but has no effect.

Platforms:

value

@property (nonatomic) CGFloat value; 

Discussion

Defaults to 50.0.