Interface IOverlays

Checked against interface/src/ui/overlays/Overlays.{h,cpp} 2014-09-28

Index

Methods

Methods

addOverlay

addOverlay(type: string, properties: IOverlayProperties): number

- Defined in hifi/Overlays.d.ts:28
adds an overlay with the specific properties

Parameters
- type: string
  
  valid values: image, text, cube, sphere, line3d, localvoxels, localmodels, model, billboard
- properties: IOverlayProperties
Returns number

unsigned int

deleteOverlay

deleteOverlay(id: number)

- Defined in hifi/Overlays.d.ts:41
deletes a particle

Parameters
- id: number
  
  unsigned int

editOverlay

editOverlay(id: number, properties: IOverlayProperties): boolean

- Defined in hifi/Overlays.d.ts:35
edits an overlay updating only the included properties, will return the identified OverlayID in case of successful edit, if the input id is for an unknown overlay this function will have no effect

Parameters
- id: number
  
  unsigned int
- properties: IOverlayProperties
Returns boolean

getOverlayAtPoint

getOverlayAtPoint(point: IVec2): number

- Defined in hifi/Overlays.d.ts:47
returns the top most overlay at the screen point, or 0 if not overlay at that point

Parameters
- point: IVec2
Returns number

unsigned int

isLoaded

isLoaded(id: number): boolean

- Defined in hifi/Overlays.d.ts:53
returns whether the overlay's assets are loaded or not

Parameters
- id: number
  
  unsigned int
Returns boolean

Generated using TypeDoc