Components Object

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

Description

The Components collection object provides access to existing components in a design.

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 Function that returns the specified component using an index into the collection.
itemById Returns the Component that has the specified ID.
itemByName Function that returns the specified component by name.

Properties

Name Description
count The number of components 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

Design.allComponents, FlatPatternProduct.allComponents, WorkingModel.allComponents

Version

Introduced in version August 2014