Maven and Java3D Overview: Difference between pages

From JogampWiki
(Difference between pages)
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
Line 1: Line 1:
__TOC__
Java 3D provides an high level object oriented sets of APIs to create 3D applications in Java.


JogAmp now contains support for Maven. From <tt>2.0-rc11</tt> to <tt>2.3.2</tt>, packages are pushed to
Java 3D was initially developed by Sun Microsystems until its version 1.5.1.
[http://search.maven.org/#search|ga|1|jogamp Maven Central]. Since <tt>2.4.0</tt>, they are pushed only to [https://jogamp.org/deployment/maven/ the Jogamp Test Repository].


= Add dependencies on the correct packages =
The version 1.5.2 was the first community version (which has nothing to do with JogAmp).


If you don't know which packages you want, you almost certainly want to use the
The version 1.6.0 is the first version actively maintained by JogAmp's community and supporting JOGL 2.
<tt>jogl-all-main</tt> and <tt>gluegen-rt-main</tt> packages, as these automatically
set up the correct dependencies on the native jar files for all platforms.


N.B: Please note that the version 2.3.2 was released in 2015, is obsolete, is the last version available in Maven Central and is only mentioned as an example but the later versions are only available in the JogAmp test repository (not in Maven Central).
*[[Downloading and installing Java3D|Downloading and installing]]
 
*[[Java3D Tutorial|Tutorial]]
As an example, if your project uses JOGL <tt>2.3.2</tt>:
*[[Java3D API Documentation|API Documentation]]
 
*[[Java3D FAQ|FAQ]]
<pre>
  <dependencies>
    <dependency>
      <groupId>org.jogamp.gluegen</groupId>
      <artifactId>gluegen-rt-main</artifactId>
      <version>2.3.2</version>
    </dependency>
    <dependency>
      <groupId>org.jogamp.jogl</groupId>
      <artifactId>jogl-all-main</artifactId>
      <version>2.3.2</version>
    </dependency>
  </dependencies>
</pre>
 
Maven will pull all of the dependencies the next time you attempt to build the project.
 
Additionally, for <tt>joal</tt> and <tt>jocl</tt> support:
 
<pre>
  <dependencies>
    <dependency>
      <groupId>org.jogamp.jocl</groupId>
      <artifactId>jocl-main</artifactId>
      <version>2.3.2</version>
    </dependency>
    <dependency>
      <groupId>org.jogamp.joal</groupId>
      <artifactId>joal-main</artifactId>
      <version>2.3.2</version>
    </dependency>
  </dependencies>
</pre>
 
An example project is available in the <tt>maven</tt> subdirectory of the <tt>jogl-demos</tt> project
[https://jogamp.org/git/?p=jogl-demos.git;a=tree;f=maven].
 
= Package details =
 
For each JogAmp project, there are essentially two packages published: One contains the main compiled
jar files and any associated native library jar files, and the other simply contains <i>dependencies</i>
on those files. Using <tt>jogl-all</tt> and <tt>jogl-all-main</tt> as the example, the <tt>jogl-all</tt>
package in the jogamp.org test repository:
 
https://jogamp.org/deployment/maven/org/jogamp/jogl/jogl-all/2.3.2/
 
Note that there are many native jar files attached to the main package. However, if you were to use
the following dependency in your own project:
 
<pre>
  <dependency>
    <groupId>org.jogamp.jogl</groupId>
    <artifactId>jogl-all</artifactId>
    <version>2.3.2</version>
  </dependency>
</pre>
 
Maven would download <tt>jogl-all-2.3.2.jar</tt> but would completely ignore all of the other
native jar files. Why? The reason for this is that the native jar files are uploaded as extra artifacts
to the <tt>jogl-all</tt> package and are, in a manner of speaking, not really considered to be part of
the package where dependencies are concerned. The POM for the <tt>jogl-all-main</tt> package adds
explicit dependencies on all of the extra artifacts in the <tt>jogl-all</tt> package:
 
https://jogamp.org/deployment/maven/org/jogamp/jogl/jogl-all-main/2.3.2/jogl-all-main-2.3.2.pom
 
So, when you add a dependency on <tt>jogl-all-main</tt> in your own project, the native jar files of
<tt>jogl-all</tt> are brought in as transitive dependencies and everything works as expected.
 
= Available packages =
 
{|
|Group ID
|Artifact ID
|Since
|Description
|-
|org.jogamp.gluegen
|gluegen-rt-android
|2.0.2-rc12
|GlueGen runtime code and native libraries (Android)
|-
|org.jogamp.gluegen
|gluegen-rt-main
|2.0-rc11
|Meta-package for automatic dependency resolution for the GlueGen runtime
|-
|org.jogamp.gluegen
|gluegen-rt
|2.0-rc11
|GlueGen runtime code and native libraries
|-
|org.jogamp.gluegen
|gluegen
|2.0-rc11
|GlueGen non-runtime code and native libraries (and atomic jars)
|-
|org.jogamp.joal
|joal-main
|2.0-rc11
|Meta-package for automatic dependency resolution for JOAL
|-
|org.jogamp.joal
|joal
|2.0-rc11
|JOAL code and native libraries
|-
|org.jogamp.joal
|joal-android
|2.2.0
|JOAL Android runtime
|-
|org.jogamp.jocl
|jocl-main
|2.0-rc11
|Meta-package for automatic dependency resolution for JOCL
|-
|org.jogamp.jocl
|jocl-android
|2.2.0
|JOCL Android runtime
|-
|org.jogamp.jocl
|jocl
|2.0-rc11
|JOCL code and native libraries
|-
|org.jogamp.jogl
|jogl-all-main
|2.0-rc11
|Meta-package for automatic dependency resolution for JOGL
|-
|org.jogamp.jogl
|jogl-all
|2.0-rc11
|JOGL code and native libraries
|-
|org.jogamp.jogl
|jogl-android
|2.0.2-rc12
|JOGL code and native libraries (Android)
|-
|org.jogamp.jogl
|jogl-android-main
|2.2.0
|Meta-package for automatic dependency resolution for JOGL (Android)
|-
|org.jogamp.jogl
|jogl-mobile-main
|2.0-rc11
|Meta-package for automatic dependency resolution for JOGL (mobile)
|-
|org.jogamp.jogl
|jogl-mobile
|2.0-rc11
|JOGL mobile code and native libraries (without AWT)
|-
|org.jogamp.jogl
|jogl-noawt-main
|2.0-rc11
|Meta-package for automatic dependency resolution for JOGL (without AWT)
|-
|org.jogamp.jogl
|jogl-noawt
|2.0-rc11
|JOGL code and native libraries (without AWT)
|-
|org.jogamp.jogl
|jogl
|2.0.2
|JOGL atomic jar files
|-
|org.jogamp.jogl
|nativewindow
|2.0.2
|Native window drivers for NEWT (atomic jars)
|-
|org.jogamp.jogl
|nativewindow-main
|2.2.0
|Native window drivers for NEWT (atomic frontend)
|-
|org.jogamp.jogl
|newt
|2.0.2
|NEWT code and native libraries (atomic jars)
|-
|org.jogamp.jogl
|newt-main
|2.2.0
|NEWT code and native libraries (atomic frontend)
|-
|org.jogamp.jogl
|occulusvr
|2.2.0
|JOGL code and native libraries (Oculus VR atomic jar files)
|-
|}
 
= Atomic jar files (optional) =
 
The so-called <i>atomic</i> jar files are provided as attachments to the <tt>jogl</tt>, <tt>newt</tt>,
<tt>nativewindow</tt> and <tt>gluegen</tt> packages. As an example, to depend only on the Linux AMD64
native jar files, on X11, using only the core of <tt>jogl</tt> and the native window toolkit in your
own projects, use the following dependencies:
 
<pre>
  <dependency>
    <groupId>org.jogamp.gluegen-rt</groupId>
    <artifactId>jogl</artifactId>
    <version>2.3.2</version>
  </dependency>
  <dependency>
    <groupId>org.jogamp.gluegen-rt</groupId>
    <artifactId>jogl</artifactId>
    <version>2.3.2</version>
    <classifier>natives-linux-amd64</classifier>
  </dependency>
  <dependency>
    <groupId>org.jogamp.jogl</groupId>
    <artifactId>jogl</artifactId>
    <version>2.3.2</version>
    <classifier>core</classifier>
  </dependency>
  <dependency>
    <groupId>org.jogamp.jogl</groupId>
    <artifactId>jogl</artifactId>
    <version>2.3.2</version>
    <classifier>natives-linux-amd64</classifier>
  </dependency>
  <dependency>
    <groupId>org.jogamp.jogl</groupId>
    <artifactId>jogl</artifactId>
    <version>2.3.2</version>
    <classifier>os-x11</classifier>
  </dependency>
  <dependency>
    <groupId>org.jogamp.jogl</groupId>
    <artifactId>jogl</artifactId>
    <version>2.3.2</version>
    <classifier>os-x11</classifier>
  </dependency>
  <dependency>
    <groupId>org.jogamp.jogl</groupId>
    <artifactId>newt</artifactId>
    <version>2.3.2</version>
    <classifier>driver-x11</classifier>
  </dependency>
  <dependency>
    <groupId>org.jogamp.jogl</groupId>
    <artifactId>newt</artifactId>
    <version>2.3.2</version>
    <classifier>core</classifier>
  </dependency>
  <dependency>
    <groupId>org.jogamp.jogl</groupId>
    <artifactId>newt</artifactId>
    <version>2.3.2</version>
    <classifier>natives-linux-amd64</classifier>
  </dependency>
  <dependency>
    <groupId>org.jogamp.jogl</groupId>
    <artifactId>nativewindow</artifactId>
    <version>2.3.2</version>
    <classifier>core</classifier>
  </dependency>
  <dependency>
    <groupId>org.jogamp.jogl</groupId>
    <artifactId>nativewindow</artifactId>
    <version>2.3.2</version>
    <classifier>natives-linux-amd64</classifier>
  </dependency>
  <dependency>
    <groupId>org.jogamp.jogl</groupId>
    <artifactId>nativewindow</artifactId>
    <version>2.3.2</version>
    <classifier>driver-x11</classifier>
  </dependency>
</pre>
 
Note that the choice of which atomic jars are required is really outside of the scope of this
documentation. It's recommended that you browse the packages in question to see which jar
files are available. It's <i>not</i> recommended to depend on platform-specific jar files
in the manner shown above unless there's an extremely good reason to do so; to do otherwise
harms portability for no good reason!
 
= The jogamp.org test repository =
 
Bleeding edge, experimental packages will continue to be made available from the
[https://jogamp.org/deployment/maven Jogamp Test Repository]. Most users won't need this, but
it can be used by adding a new profile in your <tt>~/.m2/settings.xml</tt> file that specifies
the repository:
 
<pre>
  <?xml version="1.0" encoding="UTF-8"?>
  <settings
    xmlns="http://maven.apache.org/SETTINGS/1.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
    <profiles>
      <profile>
        <id>jogamp</id>
        <repositories>
          <repository>
            <id>jogamp-remote</id>
            <name>jogamp test mirror</name>
            <url>https://www.jogamp.org/deployment/maven/</url>
            <layout>default</layout>
          </repository>
        </repositories>
      </profile>
    </profiles>
    <activeProfiles>
      <activeProfile>jogamp</activeProfile>
    </activeProfiles>
  </settings>
</pre>
 
This repository can be added into the POM file like in this [https://jogamp.org/cgit/jogl-demos.git/tree/maven/trivial-test/pom.xml very simple example].
 
Maven will then check this repository for packages in addition to Maven Central when resolving dependencies.
 
'''''Please note that some packages on the Jogamp test repository are subject to unannounced changes at any moment and may break existing code at any time! Do not use for production code!'''''
 
Since <tt>2.4.0</tt>, the releases and the release candidates are pushed only to this repository.
 
= Android =
 
There is a [[Maven_And_Android|separate page]] documenting one method of producing packages that work on both Android and ordinary
desktop Java.
 
= Producing a fat jar =
 
See [[JogAmp_JAR_File_Handling#Maven_Assembly_Plugin|JAR File Handling]].

Latest revision as of 18:13, 10 July 2023

Java 3D provides an high level object oriented sets of APIs to create 3D applications in Java.

Java 3D was initially developed by Sun Microsystems until its version 1.5.1.

The version 1.5.2 was the first community version (which has nothing to do with JogAmp).

The version 1.6.0 is the first version actively maintained by JogAmp's community and supporting JOGL 2.