SurfaceComponent
Extends:
Component wrapping a Surface object
Example:
// get a surface component by loading a surface file into the stage
stage.loadFile( "url/for/surface" ).then( function( surfaceComponent ){
surfaceComponent.addRepresentation( "surface" );
surfaceComponent.autoView();
} );
Constructor Summary
Public Constructor | ||
public |
constructor(stage: Stage, surface: Surface, params: ComponentParameters) |
Method Summary
Public Methods | ||
public |
addRepresentation(type: String, params: SurfaceRepresentationParameters): RepresentationComponent Add a new surface representation to the component |
|
public |
dispose() |
|
public |
|
|
public |
|
Inherited Summary
From class Component | ||
public get |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
Events emitted by the component |
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
addAnnotation(position: Vector3, content: String | Element, params: Object): Annotation Add an anotation object |
|
public |
|
|
public |
addRepresentation(type: String, object: Object, params: RepresentationParameters): RepresentationComponent Add a new representation to the component |
|
public |
Automatically center and zoom the component |
|
public |
dispose() |
|
public |
eachAnnotation(callback: Function): undefined Iterator over each annotation and executing the callback |
|
public |
eachRepresentation(callback: Function): undefined Iterator over each representation and executing the callback |
|
public |
|
|
public abstract |
|
|
public |
|
|
public |
|
|
public |
getZoom() |
|
public |
|
|
public |
Remove all annotations from the component |
|
public |
Removes all representation components |
|
public |
removeAnnotation(annotation: Annotation): undefined Remove the give annotation from the component |
|
public |
Removes a representation component |
|
public |
setName() |
|
public |
setPosition(p: Vector3 | Array): Component Set position transform |
|
public |
setRotation(r: Quaternion | Euler | Array): Component Set rotation transform |
|
public |
Set scale transform |
|
public |
|
|
public |
setTransform(m: Matrix4): Component Set general transform. |
|
public |
setVisibility(value: Boolean): Component Set the visibility of the component, including added representations |
|
public |
|
|
public |
|
Public Constructors
public constructor(stage: Stage, surface: Surface, params: ComponentParameters) source
Override:
Component#constructorParams:
Name | Type | Attribute | Description |
stage | Stage | stage object the component belongs to |
|
surface | Surface | surface object to wrap |
|
params | ComponentParameters | component parameters |
Public Members
public surface source
Public Methods
public addRepresentation(type: String, params: SurfaceRepresentationParameters): RepresentationComponent source
Add a new surface representation to the component
Override:
Component#addRepresentationParams:
Name | Type | Attribute | Description |
type | String | the name of the representation, one of: surface, dot. |
|
params | SurfaceRepresentationParameters | representation parameters |
Return:
RepresentationComponent | the created representation wrapped into a representation component object |