WanaPlan

API Docs for: 2.7.0
Show:

PedagoComponent

Extends BaseComponent2D
Module: Component
Parent Module: Wanaplan

Summary

This component tests the browser capabilities and redirects the user to the suitable page.

Constructor

PedagoComponent

Syntax

PedagoComponent

(
  • core
)

Summary

Parameters:

  • core Core

    The main engine.

Methods

checkBrowserCapability

Syntax

checkBrowserCapability

() Boolean

Summary

Tests the browser WebGL capabilities and redirects the user to the suitable page.

Returns:

Boolean:

True if the browser supports Wanaplan, false if it does not.

destroy

Inherited from BaseComponent2D:

Syntax

destroy

()

Summary

Method called when the component is destroyed

disable

Inherited from BaseComponent2D:

Syntax

disable

()

Summary

Disables the component

enable

Inherited from BaseComponent2D:

Syntax

enable

()

Summary

Enables the component

getPageURL

Syntax

getPageURL

(
  • page
)
String private

Summary

Gets the url of a pedago page.

Parameters:

Returns:

String:

Returns the complete url of the page.

getTargeted

Inherited from BaseComponent2D:

Syntax

getTargeted

(
  • vector
)
Object

Summary

Finds out if the given position is over an element handled by the component

Parameters:

  • vector Vector

    A position, usually the cursor's one.

Returns:

Object:

The targeted element, or null if nothing is found.

initialize

Inherited from BaseComponent2D:

Syntax

initialize

()

Summary

Method called when Wanaplan is initialized. You don't need to call this method manually.

onContextChanged

Inherited from BaseComponent2D:

Syntax

onContextChanged

(
  • context
)

Summary

Method called when the context is switched (2D -> 3D or 3D -> 2D)

Parameters:

  • context String
    The new context

redirectToPage

Syntax

redirectToPage

(
  • page
)
private

Summary

Redirects the browser to a page.

Parameters:

startListening

Inherited from BaseComponent2D:

Syntax

startListening

()

Summary

Calls all the event listeners.

stopListening

Inherited from BaseComponent2D:

Syntax

stopListening

()

Summary

Removes all the event listeners.

update

Inherited from BaseComponent2D:

Syntax

update

()

Summary

Generic update method, called on every frame

Properties

name

Inherited from BaseComponent2D:

Syntax

name

String

Summary

Component name

priority

Inherited from BaseComponent2D:

Syntax

priority

Number

Summary

Priority of the component in the "update" and "draw" routines

structure

Inherited from BaseComponent2D:

Syntax

structure

wnp.Structure

Summary

Structure file instance (shortcut to wanaplan.structure). This is the base object where the whole plan is saved