PFHotspot Protocol Reference

Declared in PFView.h

Overview

The PFHotspot protocol for view-dependent hotspot objects.

– setSize: required method

Set the current size of the hotspot. Defaults to 1.0

- (void)setSize:(float)radius

Parameters

radius

Size as a radius.

Discussion

Set the current size of the hotspot. Defaults to 1.0

Declared In

PFView.h

– setHitRadius: required method

Set the current size of the hitspot of the hotspot. Defaults to 1.2 times the size of the hotspot radius.

- (void)setHitRadius:(float)radius

Parameters

radius

Size as a radius.

Discussion

Set the current size of the hitspot of the hotspot. Defaults to 1.2 times the size of the hotspot radius.

Declared In

PFView.h

– setCoordinates:andX:andZ: required method

Set the polar coordinates of the hotspot in degrees.

- (void)setCoordinates:(float)rotY andX:(float)rotX andZ:(float)rotZ

Parameters

rotY

rotation around the y-axis, moving the hotspot left or right on the screen (0 to 360 degrees).
rotX

rotation around the x-axis, moving the hotspot up or down on the screen (-90 to 90 degrees).
rotZ

rotation around the z-axis, not supported at the moment.

Discussion

Set the polar coordinates of the hotspot in degrees.

Declared In

PFView.h

– setTag: required method

Tag the hotspot with a int.

- (void)setTag:(int)tag

Parameters

tag

The tag for the hotspot.

Discussion

Tag the hotspot with a int.

Declared In

PFView.h

– getTag required method

Retrieve the tag for the hotspot.

- (int)getTag

Discussion

Retrieve the tag for the hotspot.

Declared In

PFView.h

– addTarget:action: required method

Set the selector to trigger when the hotspot is touched. The selector should be in the form -(void)method:(id)hotspot;

- (void)addTarget:(id)target action:(SEL)action

Parameters

target

The target class.
action

The selector to call.

Discussion

Set the selector to trigger when the hotspot is touched. The selector should be in the form -(void)method:(id)hotspot;

Declared In

PFView.h

– setAlpha: required method

Set an alpha value for the hotspot

- (void)setAlpha:(float)alpha

Parameters

alpha

The alpha value from 0.0f to 1.0f.

Discussion

Set an alpha value for the hotspot

Declared In

PFView.h

– getAlpha required method

Retrieve the alpha value for the hotspot.

- (float)getAlpha

Discussion

Retrieve the alpha value for the hotspot.

Declared In

PFView.h

– animate required method

Animate the hotspot. This is a fixed animation for now.

- (void)animate

Discussion

Animate the hotspot. This is a fixed animation for now.

Declared In

PFView.h

– getState required method

Hotspot state

- (int)getState

Discussion

Hotspot state

Declared In

PFView.h