https://github.com/calvin-l/sj3d

A simple 3D software renderer for Java
https://github.com/calvin-l/sj3d

Last synced: 2 months ago
JSON representation

A simple 3D software renderer for Java

• Host: GitHub
• URL: https://github.com/calvin-l/sj3d
• Owner: Calvin-L
• Created: 2013-10-16T06:33:26.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2021-06-17T00:57:54.000Z (over 3 years ago)
• Last Synced: 2024-04-23T02:10:47.508Z (8 months ago)
• Language: Java
• Size: 112 KB
• Stars: 12
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# Simple Java 3D

This is a 3D software rendering library for Java.

It was largely inspired by Peter Walser's excellent IDX3D Java software

renderer.  (IDX3D's official website is long-dead, but Alessandro Borges has

thrown up a [clone of IDX3D on GitHub](https://github.com/AlessandroBorges/IDX3D).)

## Features

 - all Java, no native libraries

 - tiny codebase (suitable for applets and small applications)

 - no external dependencies beyond the Java standard library

 - pretty fast (for a software renderer)

 - flat shading and smooth (Gouraud) shading

 - single-color and UV texture mapped materials

 - motion blur

 - can import OBJ files

 - can import MD2 files

 - picking (can identify what model is at a given x,y screen location)

 - antialiasing (pretty hacky, but it works)

Stuff that this does NOT do:

 - shadows

 - hardware acceleration

## Building the library

This command will generate sj3d.jar:

    make

To create a "doc" folder with javadocs:

    make doc

## Running the demo

A small demo is provided to prove that this stuff works. To build and run the

demo:

    make demo

## Using the library (and scene organization)

The library is pretty arcane. Here's how the pieces fit together. (The best

source of information on how to use this stuff is probably the demo app.)

    World

        RenderSettings

        Camera

            Position

            Target point (what the camera is looking at)

            Transformation (matrix)

        Models

            Material (color, diffuse, ambient properties)

                Texture (required only if material is textured)

            Transformation (matrix)

            Frames (to support animated models - different verts for each frame)

                Vertices

                    Vector (vertex normal, required only for smooth shading)

            Triangles (references vertices on the model by number)

                UVCoord (required only for textured surfaces)

## Known issues

 - API design does not prevent you from misunderstanding it and causing

   exceptions in the rendering engine (null pointer, array out of bounds, etc)

 - documentation is slim to nonexistant

## Why?

Mostly as an educational experience. It could possibly fill a role where native

libraries are not an option or the application needs to be very very small.