Skip to content

Latest commit

 

History

History
203 lines (153 loc) · 8.97 KB

api.md

File metadata and controls

203 lines (153 loc) · 8.97 KB
Raw

Hooks API

The hooks are useful to get access to scene or engine object or get access to render loop or hover/click on meshes, etc. The hooks for SceneLoader and AssetManager require that the component using them be enclosed in Suspense.

(This is just generated for now and needs cleanup + examples)

Hooks API documentation

Code generated API

Due to using code generation from the Babylon typings, all of these declarative elements will adhere to the same API (See CustomProps below for exceptions) as you find on Babylon.js documentation site:

If you want to declaratively use something not listed here create an issue :) Some extensions have been added to allow for declarative scene creation (ie: Shadows, Textures, etc.)

@babylonjs/core API Support

  1. Node -> Mesh - abstractMesh, goldbergMesh, greasedLineBaseMesh, greasedLineMesh, greasedLineRibbonMesh, groundMesh, instancedLinesMesh, instancedMesh, linesMesh, mesh, trailMesh

  2. Cameras - anaglyphArcRotateCamera, anaglyphFreeCamera, anaglyphGamepadCamera, anaglyphUniversalCamera, arcFollowCamera, arcRotateCamera, camera, deviceOrientationCamera, flyCamera, followCamera, freeCamera, gamepadCamera, stereoscopicArcRotateCamera, stereoscopicFreeCamera, stereoscopicGamepadCamera, stereoscopicScreenUniversalCamera, stereoscopicUniversalCamera, targetCamera, touchCamera, universalCamera, virtualJoysticksCamera, vrDeviceOrientationArcRotateCamera, vrDeviceOrientationFreeCamera, vrDeviceOrientationGamepadCamera, webXrCamera

  3. Geometries (meshes) - box, capsule, cylinder, dashedLines, decal, disc, extrudePolygon, extrudeShape, extrudeShapeCustom, geodesic, goldberg, ground, groundFromHeightMap, icoSphere, lathe, lines, lineSystem, plane, babylon-polygon, polyhedron, ribbon, sphere, babylon-text, tiledBox, tiledGround, tiledPlane, torus, torusKnot, tube

    note: babylon-polygon and babylon-text instead of polygon due to JSX conflict with React.SVGProps<SVGPolygonElement>

  4. Materials - backgroundMaterial, fluentBackplateMaterial, fluentButtonMaterial, fluentMaterial, greasedLineSimpleMaterial, handleMaterial, material, mrdlBackglowMaterial, mrdlBackplateMaterial, mrdlFrontplateMaterial, mrdlInnerquadMaterial, mrdlSliderBarMaterial, mrdlSliderThumbMaterial, multiMaterial, nodeMaterial, occlusionMaterial, pbrBaseMaterial, pbrBaseSimpleMaterial, pbrMaterial, pbrMetallicRoughnessMaterial, pbrSpecularGlossinessMaterial, pushMaterial, shaderMaterial, standardMaterial

note: Materials can have configuration (read-only) properties as classes. With assignFrom prop you can declare detailMapConfiguration, imageProcessingConfiguration pbrClearCoatConfiguration, pbrIridescenceConfiguration, pbrAnisotropicConfiguration, pbrbrdfConfiguration, pbrSheenConfiguration, pbrSubSurfaceConfiguration or prePassConfiguration to attach to declaratively. PBRBaseMaterial has all, while StandardMaterial has only detailMapConfiguration. (prePassConfiguration has no updateable properties, but can be attached).

  1. Lights - directionalLight, hemisphericLight, light, pointLight, shadowLight, spotLight

  2. Textures - advancedDynamicTexture, baseTexture, colorGradingTexture, cubeTexture, customProceduralTexture, dynamicTexture, equiRectangularCubeTexture, hdrCubeTexture, htmlElementTexture, mirrorTexture, multiRenderTarget, multiviewRenderTarget, noiseProceduralTexture, prePassRenderTarget, proceduralTexture, rawCubeTexture, rawTexture, rawTexture2DArray, rawTexture3D, refractionTexture, renderTargetTexture, texture, thinRenderTargetTexture, thinTexture, videoTexture, xrSpaceWarpRenderTarget

  3. EffectLayers - effectLayer, glowLayer, highlightLayer

  4. Behaviors - autoRotationBehavior, bouncingBehavior, framingBehavior, attachToBoxBehavior, fadeInOutBehavior, followBehavior, handConstraintBehavior, multiPointerScaleBehavior, pointerDragBehavior, sixDofDragBehavior, surfaceMagnetismBehavior

  5. PostProcessRenderPipelines: defaultRenderingPipeline, lensRenderingPipeline, postProcessRenderPipeline, ssao2RenderingPipeline, ssaoRenderingPipeline, ssrRenderingPipeline, standardRenderingPipeline

  6. PostProcesss anaglyphPostProcess, blackAndWhitePostProcess, bloomMergePostProcess, blurPostProcess, chromaticAberrationPostProcess, circleOfConfusionPostProcess, colorCorrectionPostProcess, convolutionPostProcess, depthOfFieldBlurPostProcess, depthOfFieldMergePostProcess, displayPassPostProcess, extractHighlightsPostProcess, filterPostProcess, fxaaPostProcess, grainPostProcess, highlightsPostProcess, imageProcessingPostProcess, motionBlurPostProcess, passCubePostProcess, passPostProcess, postProcess, refractionPostProcess, screenSpaceCurvaturePostProcess, screenSpaceReflectionPostProcess, sharpenPostProcess, stereoscopicInterlacePostProcess, stereoscopicInterlacePostProcessI, subSurfaceScatteringPostProcess, tonemapPostProcess, volumetricLightScatteringPostProcess, vrDistortionCorrectionPostProcess, vrMultiviewToSingleviewPostProcess

    note: for PostProcess (and PostProcessRenderPipeline) the ImageProcessingConfiguration and PrePassConfiguration properties can be declared with assignFrom.

  7. Gizmo axisDragGizmo, axisScaleGizmo, boundingBoxGizmo, cameraGizmo, gizmo, lightGizmo, planeDragGizmo, planeRotationGizmo, positionGizmo, rotationGizmo, scaleGizmo, slateGizmo

  8. Sprites spriteManager, spritePackedManager, thinSprite, sprite

  9. Sound sound

  10. Others - adtForMesh, adtForMeshTexture, adtFullScreenUi, environmentHelper, physicsImpostor, pointsCloudSystem, shadowGenerator / cascadedShadowGenerator, layer, utilityLayerRenderer, viewport, vrExperienceHelper

@babylonjs/gui

  1. GUI3DManager

  2. 2D Controls - scrollViewerWindow, baseSlider, 'babylon-button', checkbox, colorPicker, container, control, displayGrid, 'babylon-ellipse', focusableButton, grid, 'babylon-image', imageBasedSlider, imageScrollBar, inputPassword, inputText, inputTextArea, 'babylon-line', multiLine, radioButton, rectangle, scrollBar, scrollViewer, selectionPanel, slider, stackPanel, textBlock, toggleButton, virtualKeyboard

    note: 'babylon-*' for button, ellipse, image & line due to JSX conflict with React.SVGProps<T>, otherwise use the ProperCase equivalent, but you miss editor auto-completion.

  3. 3D Controls - abstractButton3D, button3D, container3D, contentDisplay3D, control3D, cylinderPanel, handMenu, holographicBackplate, holographicButton, holographicSlate, meshButton3D, nearMenu, planePanel, scatterPanel, slider3D, spherePanel, stackPanel3D, touchButton3D, touchHolographicButton, touchHolographicMenu, touchMeshButton3D, volumeBasedPanel

Extensions (new in 2.0)

  1. dynamicTerrain

Custom Props

To be able to allow more declarative capabilities there are additional props that are not on the default babylonjs object. Other than these properties the React host elements follow the babylon API docs. These are all optional.

Props available to all host elements

  1. assignTo - Assign to this property on the parent. Parent property is cleared on unmount (ie: texture can be assigned to bump/diffuse/etc.)
  2. assignFrom - Assigned from a parent property and then participates with props (ie: PBR configurations or PostProcess properties like grain)
  3. fromInstance - Attach an instance you create (or want re-used) and the renderer will use that instance instead.
  4. disposeInstanceOnUnmount - Applicable only when using fromInstance. Defaults to false, but you can set to true for automatic cleanup.

AdvancedDynamicTexture

  1. createForParentMesh - Same as factory method for attaching an ADT to a plane and then the child components are 2D controls.

Control3D

  1. childrenAsContent - for 3D control ".content" (which is 2D)
  2. linkToTransformNodeByName -for Control3D, which has position, but not other properties like rotation
  3. onControlAdded - callback when control is added.

GlowLayer

  1. addIncludeOnlyChildren - Adds all child nodes to the glow layer (and nothing else).

Material

  1. attachToMeshesByName - For attaching the same material to multiple meshes (by mesh name)

Meshes

  1. childMeshesNotTracked - Useful if you attach children to a mesh and want the child meshes to participate in GlowLayer or ShadowGenerator (see props below).

ShadowGenerator

  1. shadowCasters - string array of mesh names to search for, which will be added as shadow casters.
  2. shadowCastersExcluding - string array of mesh names to exclude from casting shadows (all other meshes by name will cast shadows)
  3. shadowCastChildren - adds all child nodes as shadow casters.

Virtual Keyboard

  1. connectControlNames - 2d input control names
  2. defaultKeyboard - Use default keyboard

VRExperienceHelper

  1. enableInteractions - call enableInteractions().