FXyz 项目安装与使用文档-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00079/article/details/142807331

FXyz 项目安装与使用文档

FXyz A JavaFX 3D Visualization and Component Library 项目地址: https://gitcode.com/gh_mirrors/fx/FXyz

1. 项目目录结构及介绍

FXyz/
├── FXyz-Client       # 客户端相关代码
├── FXyz-Core         # 核心库代码
├── FXyz-Importers    # 导入器相关代码
├── FXyz-Samples      # 示例代码
├── gradle            # Gradle 构建配置文件
├── resources         # 资源文件
├── .gitignore        # Git 忽略文件
├── LICENSE           # 许可证文件
├── README.md         # 项目说明文件
├── THIRDPARTY-LICENSE.txt # 第三方许可证文件
├── build.gradle      # Gradle 构建脚本
├── gradle.properties # Gradle 配置文件
├── gradlew           # Gradle Wrapper 脚本（Linux/Mac）
├── gradlew.bat       # Gradle Wrapper 脚本（Windows）
└── settings.gradle   # Gradle 设置文件

目录详细介绍

FXyz-Client: 包含与客户端相关的代码，主要用于与用户界面交互。
FXyz-Core: 核心库代码，包含主要的3D可视化组件和功能。
FXyz-Importers: 用于导入不同3D模型格式的代码。
FXyz-Samples: 提供了多个示例项目，帮助用户快速上手。
gradle: 包含Gradle构建配置文件。
resources: 存放项目所需的资源文件。
.gitignore: 指定Git忽略的文件和目录。
LICENSE: 项目许可证文件。
README.md: 项目说明文件，包含项目简介、构建方法和使用指南。
THIRDPARTY-LICENSE.txt: 第三方依赖的许可证文件。
build.gradle: Gradle构建脚本，定义了项目的依赖和构建任务。
gradle.properties: Gradle配置文件，用于设置Gradle环境。
gradlew 和 gradlew.bat: Gradle Wrapper脚本，用于在不同操作系统上运行Gradle。
settings.gradle: Gradle设置文件，用于配置项目结构和依赖关系。

2. 项目启动文件介绍

项目的启动文件主要是 FXyz-Samples 目录中的示例代码。以下是一个示例项目的启动类：

package org.fxyz3d;

import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.PerspectiveCamera;
import javafx.scene.Scene;
import javafx.scene.SceneAntialiasing;
import javafx.scene.paint.Color;
import javafx.scene.shape.CullFace;
import javafx.stage.Stage;
import org.fxyz3d.shapes.primitives.SpringMesh;
import org.fxyz3d.utils.CameraTransformer;

public class Sample extends Application {
    @Override
    public void start(Stage primaryStage) throws Exception {
        PerspectiveCamera camera = new PerspectiveCamera(true);
        camera.setNearClip(0.1);
        camera.setFarClip(10000.0);
        camera.setTranslateX(10);
        camera.setTranslateZ(-100);
        camera.setFieldOfView(20);
        CameraTransformer cameraTransform = new CameraTransformer();
        cameraTransform.getChildren().add(camera);
        cameraTransform.ry.setAngle(-30.0);
        cameraTransform.rx.setAngle(-15.0);

        SpringMesh spring = new SpringMesh(10, 2, 2, 8 * 2 * Math.PI, 200, 100, 0, 0);
        spring.setCullFace(CullFace.NONE);
        spring.setTextureModeVertices3D(1530, p -> p.f);

        Group group = new Group(cameraTransform, spring);
        Scene scene = new Scene(group, 600, 400, true, SceneAntialiasing.BALANCED);
        scene.setFill(Color.BISQUE);
        scene.setCamera(camera);

        primaryStage.setScene(scene);
        primaryStage.setTitle("FXyz3D Sample");
        primaryStage.show();
    }

    public static void main(String[] args) {
        launch(args);
    }
}

启动步骤

打开终端或命令提示符。
切换到项目根目录。
运行以下命令启动示例项目：

./gradlew run

或者，如果你使用的是Maven项目：

mvn javafx:run

3. 项目配置文件介绍

build.gradle

build.gradle 是Gradle的主要配置文件，定义了项目的依赖和构建任务。以下是一个示例配置：

plugins {
    id 'application'
    id 'org.openjfx.javafxplugin' version '0.1.0'
}

application {
    mainClass = 'org.fxyz3d.Sample'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.fxyz3d:fxyz3d:0.6.0'
}

javafx {
    modules = ['javafx.controls']
}