(DOC) PiXYZ STUDIO Getting Started - 2018 - 2
(DOC) PiXYZ STUDIO Getting Started - 2018 - 2
Graphical interface
a. Overview 4 THIS TUTORIAL EXPLAINS HOW TO CONFORM YOUR 3D DATA TO
b. Custom toolbar & menus 5 VIRTUAL & AUGMENTED REALITY APPLICATIONS, PHYSIC & FLUID
TO PiXYZ STUDIO
c. Product structure and part selection 6
d. Properties 7
Following items are described :
e. Modifiers 8 ▪ GUI presentation
f. Viewer 9 ▪ Import Wizard
g. Visualization Tools ▪ Tessellation
a. Measurement tools 12 ▪ Remove Holes
b. Cutting plane 12 ▪ Hidden Removal
c. Exploded view 13 ▪ Decimation
h. Functions list 14
Definitions of words followed by * are given at the end of this tutorial.
i. Material Editor 15
j. Script Editor 16
Tutorial Part 1 17
Tutorial Part 2 22
Definitions 28
G E N E R A L P R E S E N TAT I O N
GENERAL INFORMATION PRODUCTS & PREREQUESITES
VERSION PiXYZ STUDIO comes in two different offers : PiXYZ STUDIO and PiXYZ STUDIO.batch
PREREQUISITES
RECOMMENDED FOR OPTIMAL DATA MINIMUM
PREPARATION Processor
Processor 86 dual-core 2GHz
Intel core i7 2 GHz or more RAM
RAM 4 GB
16 GB or more Graphics Hardware
Graphics Hardware OpenGL 4 compatible
nVidia Geforce GTX 980Ti or more Disk Space
Disk Space 200 MB
1 GB or more (with dynamic swap) Operating System
Operating System Windows XP, Seven, 10 64-bit
Windows 10, 64-bit
ACIS ✓
AutoCAD 3D ✓
FORMATS Compatibility with CAD file formats :
Autodesk Alias ✓
Autodesk FBX ✓ Version 2011 to 2017
Autodesk Inventor ✓
CATIA V4 – V5 ✓ CATProduct, CATPart
CATIA V5 [3DXML] ✓ 3DXML & CGR
MODEL
CATIA V6 [3DXML] ✓
Creo - Pro/E ✓
COLLADA ✓
CSB Deltagen ✓ Partial. Up to DG18
IFC ✓
IGES ✓
JT ✓ Mesh + NURBS | Includes PLMXML support
OBJ ✓
Parasolid ✓
PDF ✓
PLM XML ✓
PLY ✓
Point Cloud ✓ E57, PTS, PTX, XYZ
PRC ✓
Revit ✓ Beta
Rhino3D ✓
SketchUp ✓
Solid Edge ✓
SolidWorks ✓
STEP ✓
Stereo Lithography (STL) ✓
U3D ✓
Copyright © 2018 PiXYZ Software
P i X Y Z S T U D I O D O C U M E N TAT I O N
- Menu Bar
- Main Toolbar
- Product structure
- Viewer
- Selected object properties
- Modifiers stack
- Log output
- Script
The entire user interface is customizable. The position and the size of each window can be adjusted and clipped on each corner of the
interface. The menu that appears by right-clicking on the toolbar or by pushing on the tab « Windows » allows to manage the windows
visibility, create custom GUI, reset default settings,
The viewer displays information regarding the loaded model : occurrences (parts) and triangles (polygons) number.
Copyright © 2018 PiXYZ Software
GRAPHICAL INTERFACE STANDARD MENU BAR
EDIT
• Fit : Fit camera-view to selection
• Show Hidden : Switch to no-show (hidden parts)
FILE management system • Take Screenshot : Save current viewer as an image
• Select All : Select all occurrences (parts)
• Open Project : Open .pxz project file
• Invert Selection : Switch selection
• Save Project : Save current project
• Find Selection In Tree : Identify selection in product hierarchy
• Save Project As : Save as new *.pxz project
• Show B-Reps : Display native CAD representation
• Import Wizard : Opens the Import Wizard window
• Show Wireframe : Display polygons
• Import Model : Import CAD file (all formats)
• Show Shaded : Display shaded mesh
• Export Model : Export geometry
• Show Outlines : Display lines and patches information
• Export Selection : Export selected geometry
• Show Points : Display Point Cloud
• Recent Project : List of the projects recently open
• Function List : Open PiXYZ Core Function List
• Reset Project : Reset PiXYZ scene
• Install Plugin : Install a PiXYZ STUDIO plugin (contact PiXYZ)
• Exit : Quit PiXYZ STUDIO
• Plugin List : Manage installed plugins (contact PiXYZ)
• Preferences : Open PiXYZ STUDIO settings
SELECTION
• Select All : Select all occurrences (parts)
• Invert Selection : Switch selection
• Find Selection In Tree : Identify selection in product hierarchy
• Select Small Parts : Automatically select parts based on geometrical property : bounding box max diagonal
distance
• Select Part from No Show: Automatically select parts with « Visibility » attribute set to false.
• Identify Multiple Occurrences : Select parts with numerous identical entities ( = occurrences = instances)
• Select Identical : Automatically scan the entire scene to identify similar part to current selection. Please
select a part before using.
NOTE : Following tools require tessellated models
• Select Duplicated Parts: Automatically select parts with similar size, polygon count, position and orientation.
• Hidden Selection : Automatically select parts, patches or polygons not viewed from a sphere around the
scene
• Smart Hidden Selection : Select parts, patches or polygons not viewed from a set of camera automatically
These advanced selection tools will definitely ease and accelerate your data preparation processes into PiXYZ STUDIO. Other « smart »
selection can be achieved through python scripting. Please contact PiXYZ Software for more information.
PiXYZ STUDIO already exposes most powerful features in the standard GUI. However, more than 120 functions
are available in the PiXYZ API for python scripting but also interactive Data Preparation.
Go to menu EDIT > Preferences to access the full functions list (or press F12).
Go to the API Documentation for more information regarding algorithms in PiXYZ STUDIO.
Custom menus allow users to create bespoke list of functions and make easily accessible most used functions, for a specific workflow.
7
By pushing on « Go to Documentation », you can get more information on a function.
6
Copyright © 2018 PiXYZ Software
P i X Y Z S T U D I O D O C U M E N TAT I O N
3 D N AV I G AT I O N
3D NAVIGATION STANDARD (ALT + mouse)
To manipulate the camera position and orientation in the viewer, use the following key combinations:
ALT Alt Key + Right Click (or Mouse wheel) : Zoom A 3D move and rotate gizmo is visible
in the viewer to help you manipulate
the view.
Mouse Middle Click : Change rotation center (camera pivot point) PiXYZ STUDIO viewer is Y-up
oriented
Mouse Left Key + Selection area : Select parts inside the selection
Mouse Right Click + Selection area : Select all parts inside the selection (depth-selection)
To manipulate the camera position and orientation in the viewer, use the following key combinations :
Mouse Left Click + Selection area : Select visible parts inside the selection
Mouse Right Click + Selection area : Select all parts inside the selection (depth-selection)
14
0 1 2 3 4 5 6 7 8 9 10 11 12 13
0 IMPORT WIZARD Import wizard for easy 3D file import in PiXYZ STUDIO
2 EXPORT SCENE Export the complete geometry in various file formats (FBX, 3DXML, )
6 CHECKER Visual override of all materials visible in the scene using predefined shaders
B-REP Polygons / triangles Shaded Mesh Patches borders & lines Point clouds
The viewer can be customized from the « PREFERENCES » menu (F9). Background, lights, lines
colors, FOV can be adjusted to your needs.
PiXYZ STUDIO preserves your CAD model hierarchy, organization and naming, when available. The elements that
compose a scene tree, are represented as following:
Assembly *
Instance *
Part *
Part selection, from the viewer or directly in the tree Identify a part in the product tree
By default, actions will affect only selected elements. But you can always change the
selection in the function dialog box.
A SELECT menu is available to help selecting specific parts
Copyright © 2018 PiXYZ Software
WINDOWS PART PROPERTIES
The window displays a selected element details. In the case of a selection of several elements,
some fields are not filled.
From this window, you can also :
• show/hide selected element(s) by checking/unchecking the « Visible » box in the « Occurrence »
section
• show/hide all occurrences* of selected element(s) by checking/unchecking the « Visible » box in the
element section
• affect a material to a mesh
Pressing the button in the material field opens a « Material selector » window that allows to affect another
material to a mesh. If the list is empty, add a new material thank to the material editor tool.
The same icon allows to show either hidden elements or visible ones.
The PROPERTIES window displays all available information regarding the selected element(s). Informations are originally contained directly in the CAD file
(CATProduct, CATPart, STEP, JT, FBX, ).
Following metadata might be found, depending on the CAD model and its origin :
• PartNumber
• PartName
• AssemblyName
• Definition
• Nomenclature
• Source
• Revision
• Author
• Description
• ID PiXYZ
• ...
PIXYZ STUDIO allows to manage materials : creation, update... Also, you can 4
affect a material to a mesh when missing.
The material editor is accessible from the « MATERIALS » menu or by pushing on
the following button (1).
• Click on the button « + Add » (2). A window opens. Choose a material pattern
(3) and define the new material (4).
• Push on « edit properties » allows you to access to the shader code.
This material will be available in the Material Selector window accessible from the
1
properties window (5).
2
3
It is possible to modify actions done on a model. Indeed, all modifications can be saved to let you update or delete a process step.
Yet modifiers history is not enabled by default. You need to activate the « KeepShapeHistory » option in the PREFERENCES (F9), « Algo » section of the
parameters.
Also, any parameter can be modified and any process can be updated by pushing on the « Apply » button.
The button will appear after changing a value parameter.
Any action can be cancelled by pushing the white cross : . A removal be reverted.
PiXYZ STUDIO 2018.2 release introduces a new feature: the IMPORT WIZARD.
The purpose of this wizard is to help the user obtaining, quickly and easily, ready-to-use tessellated
models (meshes) out of almost any CAD model. The resulting meshes are delivered in the PiXYZ
STUDIO interface, and can be furtherly optimized using all available algorithms, or directly exported
(through FBX, OBJ, ).
The Wizard comes as a window combining all the necessary setting for a 1-click import process.
Please read the information thereafter for information about each exposed setting, or use the to
link.
All the settings exposed in the window are also available in PiXYZ STUDIO as preferences settings, or
as functions accessible from the Menu bar
SETTINGS INFORMATION
• PRESETS 1
A combination of settings can be saved under a preset, using the bar. 1
Use the preset to restore PiXYZ default settings.
Use the available buttons to manage user presets. 2
• FILE NAME 2
Use the browser to select the CAD file you wish to import in PiXYZ STUDIO through the Wizard. 3
Only one CAD file can be imported at once using the Import Wizard. Anyway, a master assembly
file (like *.CATProduct files for example) will load all the other CAD files it references.
• COORDINATE SYSTEM 3
Use the Coordinate System settings to adapt the imported units/transformation to PiXYZ
STUDIO units/coordinate system (Millimeters / Right-handed / Z-up axis).
Default settings change a millimeters/Z-up axis scene to PiXYZ STUDIO configuration.
Right Handed: Uncheck this setting to mirror model from a left-handed coordinate system to a
right-handed one.
Y-up: Use this setting to rotate model from Z-up axis to Y-up axis.
Copyright © 2018 PiXYZ Software
IMPORT WIZARD SETTINGS
SETTINGS INFORMATION
• IMPORT OPTIONS 4
The Import Options control which data must be imported from the original CAD file, and how the
hierarchy is being processed.
Load Hidden Parts: If checked, the parts that are as set as hidden (not visible) in the imported
CAD file are also imported, and their visibility set to hidden (use the No-Show view to
display them).
Load PMI: If checked, the PMI potentially present in the imported CAD file will be imported too.
Hierarchy Mode: From the "Hierarchy Mode" drop-down list, choose one of the available
4
modes to optimize the imported model's hierarchy (also called "Product Structure" in CAD
vocabulary):
SETTINGS INFORMATION
• TESSELLATION SETTINGS 5
Tessellation Settings define the way CAD surfaces inherited from the imported CAD file are
processed to create beautiful optimized meshes.
Repair CAD: Before creating a mesh out of the imported CAD surfaces, it can be useful to
perform some preparatory work on these surfaces. The Repair CAD removes possible gaps
between CAD faces, removes overlapping faces, and tries to orient CAD faces consistently
(check the API documentation for more information).
Tessellation Quality: Define the density/visual quality of the mesh that PiXYZ STUDIO delivers.
Exposed settings are the most important ones from the Tessellate algorithm.
Check the ABOUT TESSELLATION & DECIMATION page of this documentation to learn more
about tessellation settings, or refer to the API documentation (Tessellate algorithm).
5
SETTINGS INFORMATION
• MATERIAL ASSIGNMENT 6
In a CAD file (coming from CATIA, NX, CREO, ), materials (or colors) can be assigned to the CAD
parts in many different and complex ways.
Material Assignment section defines how materials will be assigned to the imported CAD model.
A CAD model is made of parts (also called occurrences) and a hierarchy (sometimes called Product
Structure in CAD vocabulary).
A Part can have a material assigned in many different ways:
- On the Part itself through its Material Property
- On a parent of the Part, in which case the Part inherits its Material Property
- Directly on the CAD surfaces of the Part (surfaces all also called patches, see the Glossary)
Using one of the following settings, choose how to deal with material assignment when importing a
CAD file:
Keep As Assigned In The Original CAD file: Using this setting preserves the material
assignment how it was defined in the CAD software delivering the imported CAD file.
Transfer CAD Materials On Parts (default setting): All materials inherited from a parent node or 6
from the CAD surfaces of a Part are transferred to the Material Property of this Part. This
action is executed for each Part of the hierarchy. This makes the material management easier
in PiXYZ STUDIO.
PiXYZ STUDIO offers several visualization tools for CAD project review and analysis.
MEASUREMENT TOOLS
Measurement system is available to measure any type of entity : distance, radius, angle, center distance, plane inclination, .
STUDIO uses a « primitive » recognition feature (circle, polylines, points) to ease and accelerate the measurement process.
Here are the steps to perform quick measurements :
1. SELECT the type of primitive/element you are willing to measure : POLYLINE (patch boundary), CIRCLE or POINT.
2. Perform « FLY-OVER » PRIMITIVE RECOGNITION directly in the 3D Viewer to identify, select and measure elements
3. Use or re-use primitives from the « Measurement » tab to CALCULATE distances, radius, or convert point to
primitives (circle center, )
Measurement Tab
Fly-over primitive identification Re-use existing primitives Administrate, hide, show all Advanced properties for
and feature measurement to identify other features measurements selected measurement
SNAPPING FUNCTIONALITY
• SNAPPING ON LINES Measure point will snap on eventual
proximity conception line (green dot )
• STANDARD PICKING Orange dot
Line snapping No snapping
CUTTING PLANE
The cutting plane feature allows to visualize inside a model. Check the « Enabled » option for activation and choose the
cutting axis. Slide the translation cursor to move the cutting plane.
SHOW PLANE : visualize solids Sectional view : SHOW PLANE + Sectional drawing or « footprint » : SHOW PLANE + ALIGN CAMERA
and hollow volumes ALIGN CAMERA + Orthographic view setting + Orthographic view setting + HIDE « Product » motion group
+ EDGE COLORS red
EXPLODED VIEW
The « Exploded View » feature spreads outward all the model parts, according to a defined axis (XYZ, planar or
single-axis). This tool allows to visualize all components inside an element.
FTA with annotations and predefined sectional view FTA sample visualization Product Structure with FTA
PIXYZ STUDIO lets you create your own script to feet your customs requirements. From the script editor,
you can write and execute Python scripts.
All the functions are accessible from the documentation. Only the import and export functions are not
available in PiXYZ STUDIO (IO license token required).
Some actions manually applied to a model can be automatically scripted in Python. From
the MODIFIERS window, push on the « Generate script » button. The corresponding script
is written in the script editor.
Specific workshops and training regarding python scripting in PiXYZ can be delivered through
engineering or on-site training sessions. Please contact PiXYZ.
PiXYZ STUDIO.batch is a premium version including additional Import/Export functions to the Python scripting
capacities, for automatic batch processing of CAD files.
Copyright © 2018 PiXYZ Software
P i X Y Z S T U D I O D O C U M E N TAT I O N
H A N D L I N G T U TO R I A L
HANDLING TUTORIAL PART 1
OBJECTIVE Obtain a high quality tessellation from a native CAD file while respecting original geometry (see page #42 for more information regarding
differences between native CAD files and Tessellated files).
PiXYZ STUDIO creates high quality and low density meshes from almost any CAD model. It provides efficient and very fast tessellation*, thanks to a smarter
organization of vertices. The part 1 of the tutorial explains how to get a high quality 3D object for a rendering usage.
• Go to the « File » menu and choose « Import Model » or press the following button from the Main Toolbar;
• Select the file to import. Multiple files (several formats) can be imported at the same time.
PiXYZ STUDIO also handles drag & drop loading directly in the viewport:
or
Parameters
CAD models are not tessellated, they contain exact mathematical surfaces. To create meshes, or polygonal
surfaces :
• Go to the « CAD » menu and choose the « Tessellate» function or click the button from the Essential
toolbar
• Set the following parameters for a high quality tessellation* :
o Max Sag* : 0.2 mm
o Max Angle : 10
• Click on « Execute » (do not select anything or select the Root node to execute the algorithm on the
whole scene)
Parameters examples :
1. Good tessellation quality for high End 2. Extreme accuracy tessellation for physics engine :
visualization application :
Max SAG : 0.2 Max SAG : 0.1
Max Angle : NO Max Angle : 20
Before tessellating, use the function « Repair CAD » or « Assemble CAD » to prevent non-
assembled CAD elements (patches) or faces orientation issues
Copyright © 2018 PiXYZ Software
HANDLING TUTORIAL PART 1
PiXYZ STUDIO offers mesh repair features, such as polygons reconnection, normals/faces orientation unification,
topology correction
The « Repair Mesh » function can automatically correct the defaults.
To repair your model :
• Go to the « Optimize mesh » menu and choose «Repair Mesh» option or press the following button from the
Essential toolbar:
• Set 0.1 millimeter as tolerance value
• Click on « Execute » (do not select anything or select the Root node to execute the algorithm on the whole
scene)
The « Orient » and « Invert Orientation » functions are also available, but they only correct orientation issues on selected
surfaces.
Crack non-manifold
Uncheck this option to keep the non-
manifold edges *
Orient
Use this option to orient all the
polygons/faces of the model in same
direction
However the model may still have a too high number of polygons for some real-time applications.
The part 2 will explain how to reduce polygons count.
OBJECTIVE Reduce the polygons count of a high quality tessellated model by keeping a nice visual quality. This part of the tutorial explains how to get a
nice low-poly model for a Virtual Reality usage.
To reduce the triangles count, start by removing through holes with a diameter lower than 10mm :
Smart Hidden Removal A similar function is available in PiXYZ STUDIO and apply the same process yet it uses multiple cameras in all closed
volumes higher than a specified value (ideal for car interior, engine compartment, )
To remove vertices :
• Go to the « Reduce mesh» menu and choose the « Decimate » function, or push on the following button from the Essential toolbar
• Use the default parameters
• Click on « Execute » (do not select anything or select the Root node to execute the algorithm on the whole scene)
The best way to decimate a model is to combine the 3 following parameters to obtain the
lighter model while keeping an acceptable quality :
• Surfacic tolerance : the maximum distance between vertices of the original model and
resulting simplified surfaces.
• Lineic tolerance : the maximum distance between vertices of the original model and resulting
simplified lines.
• Normal tolerance : the maximum angle between original normals and those interpolated on the
simplified surface.
Thanks to the normal distortion control of PiXYZ, the visual appearance has not changed despite the significant polygons reduction.
Before DECIMATION process (env. 450k polygons) After DECIMATION (env. 76k polygons).
6 times polygons reduction
It can now be exported in one of the supported formats. To do so, go to the « File » menu and choose « Export Model » or click on the following button
to open the export window.
The format *.pxz has been created to let you save your scene. To save your project click the following button or go to the
« File » menu.
This format keeps the original CAD shapes and history Modifiers to allow modifications in a second phase.
Supported export formats FBX, glTF, JT, 3DXML, COLLADA, Stereolithography, OBJ, 3DS, PRC, PDF
CAD models inherited from CAD software (CATIA, NX, SolidWorks, Alias, STEP ) are not tessellated. They contain exact parametric/mathematical surfaces.
A CAD body (closed volume) or CAD surface (open shell surface) is composed of CAD faces (or patches), delimited by boundaries (see Glossary).
To be displayed in a 3D application, these CAD faces need to be translated into meshes. A mesh is composed of multiple connected polygons, or triangles (1
polygon = 2 coplanar triangles), forming a mesh surface that is understandable by a Graphic Card, to be rendered in a 3D application.
Moreover, CAD models can contain additional engineering and design data (metadata, PMI, ), that can be very useful to perform a targeted Data Preparation
process based on targeted properties.
DCC software (Maya, 3DSMax, Blender, ) natively create tessellated geometries, or meshes, than can be exported as FBX files (for example) to be re-
imported in Unity3D using PiXYZ PLUGIN. Note that these meshes often come with UVs (1st channel and/or 2nd channel), that can either be kept at import, or
overridden using the setting (1st channel only).
Already tessellated meshes are meant to be optimized to create LODs by performing efficient and conservative decimation on them.
CAD MESH
(patches/faces, boundaries) BREP MESHES (polygons, edges, vertices)
METADATA NO METADATA
TESSELLATION When creating a mesh out of a CAD model, PiXYZ PLUGIN uses this algorithm to create a surface mesh.
• MAX SAG: The maximum distance between the geometry and the tessellation.
This parameter ensures that mesh is similar enough to the original analytical
surface (exact geometry).
A low value means that a very fine mesh is created. The distance values are
expressed in millimeter.
Ex. with Max Sag = 0.2 mm Ex. with Max Sag = 0.1 mm
• MAX ANGLE: The maximum allowed angle between normals of two adjacent
polygons (on a same face). It allows to add more precision on short radius fillets.
Adjust the « Max angle » parameter to keep enough polygons in high curvature
areas whose radius is lower than the « Max sag » value: fillets and chamfers for
example.
DECIMATION When optimizing a tessellated model, PiXYZ PLUGIN uses this algorithm to reduce the mesh polygon density by smartly deleting
vertices. It allows precise control, preserving from bad smoothing and topological irregularities.
• NORMAL TOLERANCE: the maximum angle between original normals and those
interpolated on the simplified surface. Original mesh model: 140 846 triangles
The Normal Tolerance setting preserves the quality of how the light reacts on a
surface/mesh. Combined with the Surface Tolerance setting, it will act as a quality
controller, keeping polygons where the surface curvature is important, preserving the
visual quality of the model.
The Lineic Tolerance is meant to preserve the boundaries of the original surface
(where the edges are .
Other parameter possible: Ex. Surfacic tolerance = 1 mm Lineic tolerance = 0,1mm Normal distortion tolerance = 5
• TEXTURE COORDINATES TOLERANCE: this setting is meant to preserve the UV The polygon count is reduced to 13126 with an almost imperceptible quality loss even on
(or Texture Coordinates) while decimating a mesh (0,01 is a good value). sharp edges. The quality is better than using only a Surfacic tolerance of 0.1mm with a
triangle count widely inferior (13 126 against 66 636)
Assembly a scene node that contains components. It permits to hierarchize the product structure
Brep Boundary Representation. Method for representing shapes using the limits. Boundary representation models are composed of two parts: topology and
geometry (surfaces, curves and points). The main topological items are: faces, edges and vertices. A face is a bounded portion of a surface; an edge is a
bounded piece of a curve and a vertex lies at a point.
Occurrence As parts and assemblies can be instantiated, an occurrence is the instantiated occurrence of a component. For example, if a wheel part is
instantiated 4 times, there will be 1 part but 4 occurrence of the wheel.
Non-manifold edges Edges of polysurfaces or meshes that have more than two faces joined
Sag The sag value defines the chordal deviation for curves and surfaces. The "curve chordal deviation" represents the maximum distance between a polyline
("chord") whose end points lie on a curve and a point on this curve.
Tesselation in surface modeling and solid modeling, the method used to represent 3D objects as a collection of triangles or other polygons. All surfaces, both
curved and straight, are turned into triangles either at the time they are first created or in real time when they are rendered. The more triangles used to
represent a surface, the more realistic the rendering, but the more computation is required.
P I X Y Z - S O F T WA R E . C O M
[email protected]