krkrthreepp (threepp 3D) Reference

Reference for the classes provided by the krkrthreepp plugin, which makes threepp (a three.js-compatible C++ 3D engine) available from Kirikiri Z. It covers 110 classes in total, including 3D scene construction, geometries, materials, cameras, lights, curves/shapes, animation, and VRM/glTF loaders.

For a plugin overview and usage examples, see src/plugins/krkrthreepp/README.md.

• Threepp (namespace) — threepp plugin manual written as pseudo-code

Class list

Class	Summary
AmbientLight	Ambient light
AnimationAction	A single playing animation (returned by ModelAnimator.clipAction/play)
ArrowHelper	Arrow helper
AxesHelper	Axes helper
Bone	Bone
Box2	2D axis-aligned bounding box class
Box3	Axis-aligned bounding box (AABB) class
BoxGeometry	Box (cuboid) geometry
BoxHelper	Box helper
BufferGeometry	Buffer geometry base class
Camera	Camera base class
CameraHelper	Camera helper
CapsuleGeometry	Capsule geometry
CatmullRomCurve3	Catmull-Rom spline curve
CircleGeometry	Circle (disc) geometry
Clock	Timer class
Color	Color class
ConeGeometry	Cone geometry
CubicBezierCurve	2D cubic Bezier curve
CubicBezierCurve3	3D cubic Bezier curve
CylinderGeometry	Cylinder geometry
Cylindrical	Cylindrical coordinates class
DataTexture	Data texture
DirectionalLight	Directional light (like sunlight)
DirectionalLightHelper	Directional light helper
EdgesGeometry	Edges geometry
EllipseCurve	Ellipse curve
Euler	Euler angles class
ExtrudeGeometry	ExtrudeGeometry (extruded geometry)
Fog	Fog (linear)
FogExp2	Fog (exponential)
GLRenderer	OpenGL renderer
GLTFLoader	General-purpose glTF/GLB loader
GLTFModel	Loaded glTF model (return value of GLTFLoader)
GridHelper	Grid helper
Group	Group class
HemisphereLight	Hemisphere light
IcosahedronGeometry	Icosahedron geometry
InstancedMesh	Instanced mesh
LatheGeometry	Lathe geometry
Light	Light base class
Line	Line object
Line3	3D line segment class
LineBasicMaterial	Basic material for lines
LineCurve	2D line curve
LineCurve3	3D line curve
LineSegments	Line segments object
LOD	LOD (Level of Detail)
Material	Material base class
Matrix3	3x3 matrix class
Matrix4	4x4 matrix class
Mesh	Mesh class
MeshBasicMaterial	Basic material
MeshDepthMaterial	Depth material
MeshLambertMaterial	Lambert material
MeshMatcapMaterial	Matcap material
MeshNormalMaterial	Normal material
MeshPhongMaterial	Phong material
MeshStandardMaterial	Standard PBR material
MeshToonMaterial	Toon (cel-shading) material
ModelAnimator	Model animation player (equivalent to three.js AnimationMixer)
Object3D	Base class for 3D objects
OctahedronGeometry	Octahedron geometry
OrthographicCamera	Orthographic camera
Path	2D path
PerspectiveCamera	Perspective camera
Plane	Plane class
PlaneGeometry	Plane geometry
PlaneHelper	Plane helper
PointLight	Point light
PointLightHelper	Point light helper
Points	Point cloud object
PointsMaterial	Material for point clouds
PolarGridHelper	Polar grid helper
QuadraticBezierCurve	2D quadratic Bezier curve
QuadraticBezierCurve3	3D quadratic Bezier curve
Quaternion	Quaternion class
RawShaderMaterial	Raw shader material
Ray	Ray class
Raycaster	Raycaster
Reflector	Reflective surface object
RingGeometry	Ring (annulus) geometry
Scene	Scene class
ShaderMaterial	Shader material
Shape	Shape (2D shape with holes)
ShapeGeometry	ShapeGeometry (2D shape geometry)
Skeleton	Skeleton
SkinnedMesh	Skinned mesh
Sky	Sky object
Sphere	Sphere class
SphereGeometry	Sphere geometry
Spherical	Spherical coordinates class
SplineCurve	2D spline curve
SpotLight	Spotlight
SpotLightHelper	Spotlight helper
Sprite	Sprite object
SpriteMaterial	Material for sprites
Texture	Texture base class
TextureLoader	Texture loader
TorusGeometry	Torus (donut-shaped) geometry
TorusKnotGeometry	Torus knot geometry
Triangle	Triangle class
Vector2	2D vector class
Vector3	3D vector class
VRM	A single VRM model
VRMAnimation	VRM animation (.vrma / VRMC_vrm_animation)
VRMAnimationLoader	VRM animation loader
VRMLoader	VRM loader
Water	Water surface object
WireframeGeometry	Wireframe geometry