API Docs for: 1.0.2
Show:

GIScene.Process.LineOfSight_simpleClient Class

The Line of Sight Process calculates the visibility bewtween two points in the scene

Constructor

GIScene.Process.LineOfSight_simpleClient

()

Methods

execute

(
  • [onExecute]
)

run the process with the inputs that have been set before

Parameters:

  • [onExecute] Function optional

    callback that will be called when process is finished

getNearestIntersectionObject

(
  • referencePoint
  • intersectionObjectA
  • intersectionObjectB
)
Object private

Parameters:

  • referencePoint THREE.Vector3
  • intersectionObjectA Object

    object returned from Raycaster.intersectObjects() method

  • intersectionObjectB Object

    object returned from Raycaster.intersectObjects() method

Returns:

Object:

nearestIntersectionObject

getOutput

(
  • outputIdentifier
)
Mixed
Method to get a specific output result after process execution

Parameters:

  • outputIdentifier Object

Returns:

Mixed: an output value of the process

getOutputs

() Object
Method to get all process outputs after process execution

Returns:

Object: An object containing all process outputs

getParamDescriptionById

(
  • identifier
)
Object
Get a param desription (input or ouput) by its identifier

Parameters:

  • identifier String

Returns:

Object: parameterDescription

setInput

(
  • inputIdentifier
  • value
)
Method to set a specific input parameter

Parameters:

  • inputIdentifier String
    the inputIdentifier defined in the process description
  • value Mixed
    the value of the input to be set

setInputs

(
  • inputParams
)
Method to set several inputs at a time

Parameters:

  • inputParams Object
    An object with key:value pairs of input parameters, where key corresponds to the inputIdentifiers defined in the process description