Basic Structures in a Pixyz Scene

To get started, please check also the following topics about Pixyz concepts and vocabulary:

Pixyz objects types

  • All Pixyz objects are called entities
  • In Python Scripting, an entity is defined by a unique numerical identifier, or ID
  • The API Reference shows inheritance of entity types.

For example, a part is inherited from component, so if a function wants a component parameter you can give it a part:

Image

Pixyz Scene occurrences

  • Product Structure / Scene nodes are Occurrences
  • An occurrence can have child occurrences
  • An occurrence has Properties:
    • Name
    • Transform
    • Material
    • Visible
  • An occurrence owns components (maximum one of each type)

Image

Pixyz Studio scene components

  • List of components types:
    • Part
    • PMI
    • Light
    • Metadata
    • Variant
    • Animation
    • Joint
    • SubPart Material

Prototyping

  • Each occurrence can have a prototype, a prototype is also an occurrence
  • A prototype is a kind of pattern
  • An occurrence can override properties of its prototype occurrence

Image

See also: About Instances & Prototypes

Pixyz scene Part

  • A part contains geometry, contained in a shape
  • A part may contain one or two shapes:
    • A BRep Shape with CAD representation
    • A Tessellated Shape with Mesh representation
  • The active shape is the tessellate shape if it exists, the BRep shape otherwise.
  • A part has a local transformation matrix

Image

Common functions for scene handling

  • Get the type of an entity as a String:

    core.getEntityTypeString(entity)

  • Get/Set a property value (All property values are Strings):

    nameValue = core.getProperty(entity, "Name")
core.setProperty(entity, "Name", "NameValue")

  • List available properties on an entity:

    core.listProperties(entity)

Other Python examples

  • Occurrence list with the root:

    [scene.getRoot()]

  • Occurrence list with all parts:

    scene.getPartOccurrences()

  • Occurrence list with selection:

    scene.getSelectedOccurrences()

  • All occurrences:

    scene.findOccurrencesByProperty('Name', '.*')