F3D(1)

NAME
f3d - F3D - Fast and minimalist 3D viewer

DESCRIPTION
F3D - A fast and minimalist 3D viewer Usage:

    f3d [OPTION...] file1 file2 ...

    Applicative options:

--output <png file>
    Render to file

--no-background
    No background when render to file

-h, --help
    Print help

--version
    Print version details

--readers-list
    Print the list of file types

--config <file path>
    Read a provided configuration file instead of default one

--dry-run
    Do not read the configuration file

--no-render
    Verbose mode without any rendering, only for the first file

    Camera options:

--camera-position <X,Y,Z>
    Camera position

--camera-focal-point <X,Y,Z>
    Camera focal point

--camera-view-up <X,Y,Z>
    Camera view up

--camera-view-angle <angle>
    Camera view angle (non-zero, in degrees)

--camera-azimuth-angle <angle>
    Camera azimuth angle (in degrees) (default: 0)

--camera-elevation-angle <angle>
    Camera elevation angle (in degrees) (default: 0)

    General options:

--verbose
    Enable verbose mode, providing more information about the loaded data in the console output

--quiet
    Enable quiet mode, which superseed any verbose options and prevent any console output to be generated at all

--progress
    Show progress bar

--geometry-only
    Do not read materials, cameras and lights from file

--up [-X|+X|-Y|+Y|-Z|+Z]
    Up direction (default: +Y)

-x, --axis
    Show axes

-g, --grid
    Show grid

-e, --edges
    Show cell edges

--camera-index <index>
    Select the camera to use (default: -1)

-k, --trackball
    Enable trackball interaction

--animation-index <index>
    Select animation to show (default: 0)

--font-file <file_path>
    Path to a FreeType compatible font file

    Material options:

-o, --point-sprites
    Show sphere sprites instead of geometry

--point-size <size>
    Point size when showing vertices or point sprites (default: 10)

--line-width <width>
    Line width when showing edges (default: 1)

--color <R,G,B>
    Solid color (default: 1,1,1)

--opacity <opacity>
    Opacity (default: 1)

--roughness <roughness>
    Roughness coefficient (0.0-1.0) (default: 0.3)

--metallic <metallic>
    Metallic coefficient (0.0-1.0) (default: 0)

--hdri <file path>
    Path to an image file that will be used as a light source

--texture-base-color <file path>
    Path to a texture file that sets the color of the object

--texture-material <file path>
    Path to a texture file that sets the Occlusion, Roughness and Metallic values of the object

--texture-emissive <file path>
    Path to a texture file that sets the emitted light of the object

--emissive-factor <R,G,B>
    Emissive factor. This value is multiplied with the emissive color when an emissive texture is present (default: 1,1,1)

--texture-normal <file path>
    Path to a texture file that sets the normal map of the object

--normal-scale <normalScale>
    Normal scale affects the strength of the normal deviation from the normal texture (default: 1)

    PostFX (OpenGL) options:

-p, --depth-peeling
    Enable depth peeling

-q, --ssao
    Enable Screen-Space Ambient Occlusion

-a, --fxaa
    Enable Fast Approximate Anti-Aliasing

-t, --tone-mapping
    Enable Tone Mapping

    Scientific visualization options:

-s, --scalars [=<array_name>(=)]
    Color by scalars (default: f3d_reserved)

-y, --comp [=<comp_index>(=-2)]
    Component from the scalar array to color with. -1 means magnitude, -2 or the short option, -y, means direct scalars (default: -1)

-c, --cells
    Use a scalar array from the cells

--range <min,max>
    Custom range for the coloring by array

-b, --bar
    Show scalar bar

--colormap <color_list>
    Specify a custom colormap (default: 0,0,0,0,0.4,0.9,0,0,0.8,0.9,0.9,0,1,1,1,1)

-v, --volume
    Show volume if the file is compatible

-i, --inverse
    Inverse opacity function for volume rendering

    Testing options:

--ref <png file>
    Reference

--ref-threshold <threshold>
    Testing threshold (default: 50)

--interaction-test-record <file_path>
    Path to an interaction log file to record interactions events to

--interaction-test-play <file_path>
    Path to an interaction log file to play interaction events from when loading a file

    Window options:

--bg-color <R,G,B>
    Background color (default: 0.2,0.2,0.2)

--resolution <width,height>
    Window resolution (default: 1000,600)

-z, --fps
    Display frame per second

-n, --filename
    Display filename

-m, --metadata
    Display file metadata

-f, --fullscreen
    Full screen

-u, --blur-background
    Blur background

  Keys:

C   Cycle point/cell data coloring

S   Cycle array to color with

Y   Cycle array component to color with

B   Toggle the scalar bar display

V   Toggle volume rendering

I   Toggle inverse volume opacity

O   Toggle point sprites rendering

P   Toggle depth peeling

Q   Toggle SSAO

A   Toggle FXAA

T   Toggle tone mapping

E   Toggle the edges display

X   Toggle the axes display

G   Toggle the grid display

N   Toggle the filename display

M   Toggle the metadata display

Z   Toggle the FPS counter display

R   Toggle raytracing rendering

D   Toggle denoising when raytracing

F   Toggle full screen

U   Toggle blur background

K   Toggle trackball interaction

H   Toggle cheat sheet display

?   Dump camera state to the terminal

Escape
    Quit

Enter
    Reset camera to initial parameters

Space
    Play animation if any

Left
    Previous file

Right
    Next file

Up  Reload current file

EXAMPLES

f3d file.vtu -xtgans
    View a unstructured mesh in a typical nice looking sciviz style

f3d file.glb -tuqap --hdri=file.hdr
    View a gltf file in a realistic environment

f3d file.ply -so --point-size=0 --comp=-2
    View a point cloud file with direct scalars rendering

f3d folder
    View all files in folder

REPORTING BUGS
Report bugs to https://github.com/f3d-app/f3d/issues

F3D - A fast and minimalist 3D viewer
Version: 1.3.1.
Build date: 2022-11-06 13:17:51.
Build system: Linux.
Compiler: GNU 12.2.0.
External rendering module: OFF.
Raytracing module: OFF.
Exodus module: ON.
OpenCASCADE module: 7.6.3 (full support).
Assimp module: 5.2.4.
Alembic module: OFF.
VTK version: 9.1.0 (build 0).
Copyright © 2019-2021 Kitware SAS.
Copyright © 2021-2022 Michael Migliore, Mathieu Westphal.
License BSD-3-Clause.
By Michael Migliore, Mathieu Westphal and Joachim Pouderoux.