OccurrenceList Object

Derived from: Base Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Components/OccurrenceList.h>

Description

Provides a list of occurrences.

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().
item Returns the specified occurrence using an index into the collection.
itemByName Returns the specified occurrence using the name of the occurrence.

Properties

Name Description
count Returns the number of occurrences in the collection.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():

Accessed From

BaseComponent.allOccurrences, BaseComponent.allOccurrencesByComponent, BaseComponent.occurrencesByComponent, Component.allOccurrences, Component.allOccurrencesByComponent, Component.occurrencesByComponent, FlatPatternComponent.allOccurrences, FlatPatternComponent.allOccurrencesByComponent, FlatPatternComponent.occurrencesByComponent, Occurrence.childOccurrences, Occurrences.asList, RigidGroup.occurrences

Samples

Name Description
Assembly traversal using recursion API Sample Traverses the entire structure of the currently open assemlby using a recursive function and displays the result in a message box. This will match the occurrence structure seen in the browser.
Get Volume of Active Design API Sample Traverses through the active design and totals the volume of every body within the design.

Version

Introduced in version August 2014