SmartGL 开源项目使用教程

1. 项目的目录结构及介绍

SmartGL 项目的目录结构如下：

smart-fun/smartGL
├── app
├── extras
├── gradle/wrapper
├── smartgl
│   ├── smartglapp
│   ├── gitignore
│   ├── LICENSE
│   ├── README.md
│   ├── build.gradle
│   ├── gradle.properties
│   ├── gradlew
│   ├── gradlew.bat
│   └── settings.gradle
└── README.md

目录结构介绍

• app: 包含应用程序的主要代码和资源文件。
• extras: 可能包含一些额外的资源或工具。
• gradle/wrapper: Gradle 包装器，用于确保项目使用特定版本的 Gradle。
• smartgl: SmartGL 图形引擎的核心代码和配置文件。
  • smartglapp: SmartGL 应用程序的代码。
  • gitignore: Git 忽略文件，指定哪些文件或目录不应被版本控制。
  • LICENSE: 项目的许可证文件，采用 Apache License 2.0。
  • README.md: 项目的说明文档。
  • build.gradle: 项目的构建脚本。
  • gradle.properties: Gradle 属性配置文件。
  • gradlew: Gradle 包装器脚本，用于在 Unix 系统上运行 Gradle。
  • gradlew.bat: Gradle 包装器脚本，用于在 Windows 系统上运行 Gradle。
  • settings.gradle: Gradle 设置文件，用于配置多项目构建。

2. 项目的启动文件介绍

SmartGL 项目的启动文件是 smartgl/smartglapp/SmartGLViewController.java。该文件负责初始化和配置 SmartGL 视图，并加载 3D 对象和纹理。

启动文件代码示例

public class SmartGLViewController {
    private Object3D mSpaceship;
    private Texture mShipTexture;

    @Override
    public void onPrepareView(SmartGLView smartGLView) {
        // 创建渲染通道对象
        RenderPassObject3D renderPassObject3D = new RenderPassObject3D();
        renderer.addRenderPass(renderPassObject3D);

        // 加载纹理
        mShipTexture = new Texture(context, R.drawable.ship_picture);

        // 加载 3D 模型
        WavefrontModel model = new WavefrontModel.Builder(context, R.raw.spaceship_obj)
            .addTexture("Material001", mShipTexture)
            .create();

        // 创建 3D 对象
        mSpaceship = model.toObject3D();
        mSpaceship.setScale(0.1f, 0.1f, 0.1f); // 调整对象大小
        mSpaceship.setPos(0, 0, -5); // 移动对象到相机前
    }
}

启动文件功能介绍

• onPrepareView: 初始化 SmartGL 视图，并配置渲染通道。
• Texture: 加载纹理资源。
• WavefrontModel: 加载 3D 模型文件，并将其转换为 3D 对象。
• Object3D: 设置 3D 对象的缩放和位置。

3. 项目的配置文件介绍

SmartGL 项目的配置文件主要包括 build.gradle 和 gradle.properties。

build.gradle

build.gradle 文件是项目的构建脚本，定义了项目的依赖项、插件和其他构建配置。

// 应用插件
apply plugin: 'com.android.application'

// Android 配置
android {
    compileSdkVersion 30
    defaultConfig {
        applicationId "com.smartfun.smartgl"
        minSdkVersion 16
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

// 依赖项
dependencies {
    implementation 'com.github.smart-fun:smartGL:1.2.1'
}

gradle.properties

gradle.properties 文件用于配置 Gradle 构建工具的属性。

# 设置 Gradle 构建工具的属性
org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
android.useAndroidX=true
android.enableJetifier=true

配置文件功能介绍

• build.gradle: 定义项目的构建配置，包括 Android 版本、依赖项等。
• gradle.properties: 配置 Gradle 构建工具的属性，如 JVM 参数和 AndroidX 支持。

通过以上配置文件，可以确保项目在构建和运行时具有正确的环境和依赖项。