ISGenericRTO Class Reference

Inherits from CCNode
Conforms to ISRTO
Declared in ISGenericRTO.h

Overview

Class which represent a basic RTO object (name + pin image).

  metersPosition

RTO position in meters.

@property (nonatomic, retain) ISPosition *metersPosition

Declared In

ISGenericRTO.h

  currentMap

Current rendering map.

@property (nonatomic, retain) ISMap *currentMap

Declared In

ISGenericRTO.h

  draggable

Boolean used to know if the RTO is draggable.

@property (nonatomic, readwrite) Boolean draggable

Declared In

ISGenericRTO.h

  actionButtonClicked

Boolean used to know if the action button was clicked.

@property (nonatomic, readonly) Boolean actionButtonClicked

Declared In

ISGenericRTO.h

  rtoNode

Related 2D render node.

@property (nonatomic, retain) ISGenericRTONode *rtoNode

Declared In

ISGenericRTO.h

  currentScene

Current 3D scene (for 3D rendering only).

@property (nonatomic, weak) CC3Scene *currentScene

Declared In

ISGenericRTO.h

  windowBackgroundColorNormal

RTO window background color for normal state.

@property (nonatomic, retain) UIColor *windowBackgroundColorNormal

Declared In

ISGenericRTO.h

  windowBackgroundColorHighlighted

RTO window background color for highlighted state.

@property (nonatomic, retain) UIColor *windowBackgroundColorHighlighted

Declared In

ISGenericRTO.h

  actionImagePath

RTO action button sprite image path.

@property (nonatomic, retain) NSString *actionImagePath

Declared In

ISGenericRTO.h

  actionBackgroundColorNormal

RTO action button background color for normal state.

@property (nonatomic, retain) UIColor *actionBackgroundColorNormal

Declared In

ISGenericRTO.h

  actionBackgroundColorHighlighted

RTO action button background color for highlighted state.

@property (nonatomic, retain) UIColor *actionBackgroundColorHighlighted

Declared In

ISGenericRTO.h

  indicatorImagePath

RTO indicator sprite image path.

@property (nonatomic, retain) NSString *indicatorImagePath

Declared In

ISGenericRTO.h

  windowAnchorImagePath

RTO window anchor sprite image path.

@property (nonatomic, retain) NSString *windowAnchorImagePath

Declared In

ISGenericRTO.h

  markerImagePath

RTO marker sprite image path.

@property (nonatomic, retain) NSString *markerImagePath

Declared In

ISGenericRTO.h

– initWithName:andLabel:andMetersPosition:andWindowInitiallyDisplayed:andLabelInitiallyDisplayed:

Main constructor

- (instancetype)initWithName:(NSString *)name andLabel:(NSString *)label andMetersPosition:(ISPosition *)metersPosition andWindowInitiallyDisplayed:(Boolean)windowInitiallyDisplayed andLabelInitiallyDisplayed:(Boolean)labelInitiallyDisplayed

Parameters

name

RTO displayed name.
label

RTO displayed label.
metersPosition

RTO position in meters (could be nil in case of zone rendering).
windowInitiallyDisplayed

Boolean used to know if the RTO window has to be displayed.
labelInitiallyDisplayed

Boolean used to know if the RTO label has to be displayed.

Declared In

ISGenericRTO.h

– initWithName:andLabel:andMetersPosition:andWindowInitiallyDisplayed:andWindowShouldToggle:andLabelInitiallyDisplayed:andLabelShouldToggle:

Main constructor

- (instancetype)initWithName:(NSString *)name andLabel:(NSString *)label andMetersPosition:(ISPosition *)metersPosition andWindowInitiallyDisplayed:(Boolean)windowInitiallyDisplayed andWindowShouldToggle:(Boolean)windowShouldToggle andLabelInitiallyDisplayed:(Boolean)labelInitiallyDisplayed andLabelShouldToggle:(Boolean)labelShouldToggle

Parameters

name

RTO displayed name.
label

RTO displayed label.
metersPosition

RTO position in meters (could be nil in case of zone rendering).
windowInitiallyDisplayed

Boolean used to know if the RTO window has to be displayed.
windowShouldToggle

Boolean used to know if the RTO window should toggle on RTO clicked.
labelInitiallyDisplayed

Boolean used to know if the RTO label has to be displayed.
labelShouldToggle

Boolean used to know if the RTO label should toggle on RTO clicked.

Declared In

ISGenericRTO.h

– initWithName:andLabel:andMetersPosition:andWindowInitiallyDisplayed:andWindowShouldToggle:andLabelInitiallyDisplayed:andLabelShouldToggle:andWindowBackgroundColorNormal:andWindowBackgroundColorHighlighted:andActionEnabled:andActionImagePath:andActionBackgroundColorNormal:andActionBackgroundColorHighlighted:andIndicatorVisible:andIndicatorImagePath:andWindowAnchorImagePath:andMarkerImagePath:

Main constructor

- (instancetype)initWithName:(NSString *)name andLabel:(NSString *)label andMetersPosition:(ISPosition *)metersPosition andWindowInitiallyDisplayed:(Boolean)windowInitiallyDisplayed andWindowShouldToggle:(Boolean)windowShouldToggle andLabelInitiallyDisplayed:(Boolean)labelInitiallyDisplayed andLabelShouldToggle:(Boolean)labelShouldToggle andWindowBackgroundColorNormal:(UIColor *)windowBackgroundColorNormal andWindowBackgroundColorHighlighted:(UIColor *)windowBackgroundColorHighlighted andActionEnabled:(Boolean)actionEnabled andActionImagePath:(NSString *)actionImagePath andActionBackgroundColorNormal:(UIColor *)actionBackgroundColorNormal andActionBackgroundColorHighlighted:(UIColor *)actionBackgroundColorHighlighted andIndicatorVisible:(Boolean)indicatorVisible andIndicatorImagePath:(NSString *)indicatorImagePath andWindowAnchorImagePath:(NSString *)windowAnchorImagePath andMarkerImagePath:(NSString *)markerImagePath

Parameters

name

RTO displayed name.
label

RTO displayed label.
metersPosition

RTO position in meters (could be nil in case of zone rendering).
windowInitiallyDisplayed

Boolean used to know if the RTO window has to be displayed.
windowShouldToggle

Boolean used to know if the RTO window should toggle on RTO clicked.
labelInitiallyDisplayed

Boolean used to know if the RTO label has to be displayed.
labelShouldToggle

Boolean used to know if the RTO label should toggle on RTO clicked.
windowBackgroundColorNormal

RTO window background color (normal state).
windowBackgroundColorHighlighted

RTO window background color (highlighted state).
actionEnabled

Boolean used to know if the action button is enabled.
actionImagePath

RTO action image path.
actionBackgroundColorNormal

RTO action image background color (normal state).
actionBackgroundColorHighlighted

RTO action image background color (highlighted state).
indicatorVisible

Boolean used to know if the right indicator is visible.
indicatorImagePath

RTO indicator image path.
windowAnchorImagePath

RTO window anchor image path.
markerImagePath

RTO marker image path.

Declared In

ISGenericRTO.h

– shouldToggleWindowOnMarkerClicked

Method used to know if the RTO should toggle its window when the marker was clicked.

- (Boolean)shouldToggleWindowOnMarkerClicked

Return Value

YES if you want a toggle action, otherwise NO.

Declared In

ISGenericRTO.h

– shouldToggleLabelOnMarkerClicked

Method used to know if the RTO should toggle its label when the marker was clicked.

- (Boolean)shouldToggleLabelOnMarkerClicked

Return Value

YES if you want a toggle action, otherwise NO.

Declared In

ISGenericRTO.h

– hideWindow

Method called to hide the window.

- (void)hideWindow

Declared In

ISGenericRTO.h

– showWindow

Method called to show the window.

- (void)showWindow

Declared In

ISGenericRTO.h

– toggleWindow

Method called to toggle RTO appearance.

- (void)toggleWindow

Declared In

ISGenericRTO.h

– hideLabel

Method called to hide the RTO label.

- (void)hideLabel

Declared In

ISGenericRTO.h

– showLabel

Method called to show the RTO label.

- (void)showLabel

Declared In

ISGenericRTO.h

– toggleLabel

Method called to toggle RTO label visibility.

- (void)toggleLabel

Declared In

ISGenericRTO.h

– setOver:

Method called to render the annotation as touched or not.

- (void)setOver:(Boolean)over

Parameters

over

YES if you want a touched effect, otherwise NO.

Declared In

ISGenericRTO.h

– setOverAction:

Method called to render the action button as touched or not.

- (void)setOverAction:(Boolean)over

Parameters

over

YES if you want a touched effect, otherwise NO.

Declared In

ISGenericRTO.h