Skip to content

Commit

Permalink
add Collection objects and references to them
Browse files Browse the repository at this point in the history
  • Loading branch information
rendertom committed Aug 19, 2020
1 parent 23d3f34 commit 7015658
Show file tree
Hide file tree
Showing 16 changed files with 309 additions and 12 deletions.
3 changes: 2 additions & 1 deletion 16 - Productions object/productions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ An array of the projects containined within the Production, which are currently

**Type**

(ProjectCollection object).
:ref:`projectCollection`, read-only.

----

=======
Expand Down
41 changes: 41 additions & 0 deletions 18 - Collection/collection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.. highlight:: javascript

.. _collection:

Collection object
################################################

Like an array, a collection associates a set of objects or values as a logical group and provides access to them by index. However, most collection objects are read-only. You do not assign objects to them yourself — their contents update automatically as objects are created or deleted.

=======
Objects
=======

- :ref:`componentCollection` - *todo*.
- :ref:`markerCollection` - a collection of the :ref:`Marker objects <marker>` in a :ref:`projectItem` and :ref:`sequence`.
- :ref:`projectCollection` - a collection of :ref:`Project objects <project>`.
- :ref:`projectItemCollection` - a collection of :ref:`ProjectItem objects <projectItem>`.
- :ref:`sequenceCollection` - a collection of :ref:`Sequence objects <sequence>`.
- :ref:`trackCollection` - a collection of :ref:`Track objects <track>`.
- :ref:`trackItemCollection` - a collection of :ref:`TrackItem objects <trackItem>`.

----

==========
Attributes
==========

========== ========================================
``length`` The number of objects in the collection.
========== ========================================

-----

=======
Methods
=======

========== ==============================================================
``[]`` Retrieves an object in the collection by its index number. The
first object is at index 0.
========== ==============================================================
38 changes: 38 additions & 0 deletions 18 - Collection/componentcollection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
.. highlight:: javascript

.. _componentCollection:

ComponentCollection object
################################################

| ``app.project.rootItem.children[index].videoComponents()``
| ``app.project.sequences[index].audioTracks[index].clips[index].components``
| ``app.project.sequences[index].videoTracks[index].clips[index].components``

*add a description*

ComponentCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ComponentCollection.

----

==========
Attributes
==========

.. _componentCollection.numItems:

ComponentCollection.numItems
*********************************************

| ``app.project.rootItem.children[index].videoComponents().numItems``
| ``app.project.sequences[index].audioTracks[index].clips[index].components.numItems``
| ``app.project.sequences[index].videoTracks[index].clips[index].components.numItems``
**Description**

*add a description*

**Type**

Integer, read-only.
33 changes: 33 additions & 0 deletions 18 - Collection/markercollection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. highlight:: javascript

.. _markerCollection:

MarkerCollection object
################################################

``app.project.sequences[index].markers``

The MarkerCollection object represents a collection of :ref:`Marker objects <marker>` in a :ref:`projectItem` and :ref:`sequence`.

MarkerCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with MarkerCollection.

----

==========
Attributes
==========

.. _markerCollection.numMarkers:

MarkerCollection.numMarkers
*********************************************

``app.project.sequences[index].markers.numMarkers``

**Description**

The total number of marker objects in the sequence.

**Type**

Integer, read-only.
35 changes: 35 additions & 0 deletions 18 - Collection/projectcollection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. highlight:: javascript

.. _projectCollection:

ProjectCollection object
################################################

| ``app.projects``
| ``app.production.projects``
The ProjectCollection object represents a collection of :ref:`Project objects <project>`.

ProjectCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ProjectCollection.

----

==========
Attributes
==========

.. _projectCollection.numProjects:

ProjectCollection.numProjects
*********************************************

| ``app.projects.numProjects``
| ``app.production.projects.numProjects``
**Description**

The total number of projects and productions found in the Project panel.

**Type**

Integer, read-only.
33 changes: 33 additions & 0 deletions 18 - Collection/projectitemcollection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. highlight:: javascript

.. _projectItemCollection:

ProjectItemCollection object
################################################

``app.project.rootItem.children``

The ProjectItemCollection object represents a collection of :ref:`ProjectItem objects <projectItem>` in an active project.

ProjectItemCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ProjectItemCollection.

----

==========
Attributes
==========

.. _projectItemCollection.numItems:

ProjectItemCollection.numItems
*********************************************

``app.project.rootItem.children.numItems``

**Description**

The total number of items in the active project.

**Type**

Integer, read-only.
33 changes: 33 additions & 0 deletions 18 - Collection/sequencecollection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.. highlight:: javascript

.. _sequenceCollection:

SequenceCollection object
################################################

``app.project.sequences``

The SequenceCollection object represents a collection of all the :ref:`Sequence objects <sequence>` in the active project.

SequenceCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with SequenceCollection.

----

==========
Attributes
==========

.. _projectCollection.numSequences:

SequenceCollection.numSequences
*********************************************

``app.project.sequences.numSequences``

**Description**

The total number of sequences in the active project.

**Type**

Integer, read-only.
35 changes: 35 additions & 0 deletions 18 - Collection/trackcollection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. highlight:: javascript

.. _trackCollection:

TrackCollection object
################################################

| ``app.project.sequences[index].audioTracks``
| ``app.project.sequences[index].videoTracks``
The TrackCollection object represents a collection of :ref:`Track objects <track>` in a sequence.

TrackCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with TrackCollection.

----

==========
Attributes
==========

.. _trackCollection.numTracks:

TrackCollection.numTracks
*********************************************

| ``app.project.sequences[index].audioTracks.numTracks``
| ``app.project.sequences[index].videoTracks.numTracks``
**Description**

The total number of tracks in the sequence.

**Type**

Integer, read-only.
35 changes: 35 additions & 0 deletions 18 - Collection/trackitemcollection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. highlight:: javascript

.. _trackItemCollection:

TrackItemCollection object
################################################

| ``app.project.sequences[index].audioTracks[index].clips``
| ``app.project.sequences[index].videoTracks[index].clips``
The TrackItemCollection object represents a collection of :ref:`TrackItem objects <trackItem>` on a track.

TrackItemCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with TrackItemCollection.

----

==========
Attributes
==========

.. _trackItemCollection.numItems:

TrackItemCollection.numItems
*********************************************

| ``app.project.sequences[index].audioTracks[index].clips.numItems``
| ``app.project.sequences[index].videoTracks[index].clips.numItems``
**Description**

The total number of clips on a track.

**Type**

Integer, read-only.
2 changes: 1 addition & 1 deletion 2 - App object/application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ An array referencing all open projects; `numProjects` contains size.

**Type**

Array of :ref:`Project <project>` objects; (ProjectCollection object).
:ref:`projectCollection`, read-only.

----

Expand Down
2 changes: 1 addition & 1 deletion 3 - Project object/project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ The sequences within the project.

**Type**

An array of :ref:`Sequence <sequence>` objects; (SequenceCollection object).
:ref:`sequenceCollection`, read-only.

----

Expand Down
6 changes: 3 additions & 3 deletions 4 - ProjectItem object/projectItem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ An array of project items, contained within the specified project item.

**Type**

Array; read-only; (ProjectItemCollection object).
:ref:`projectItemCollection`, read-only.

----

Expand Down Expand Up @@ -544,7 +544,7 @@ None.

**Returns**

An array of :ref:`Marker <marker>` objects associated with the project item, or **0** if there are no markers.
:ref:`markerCollection`, read-only;

----

Expand Down Expand Up @@ -1107,4 +1107,4 @@ Video components for the 'Master Clip' of this project item.

**Type**

This array is read-only; the components are not.
:ref:`componentCollection`, read-only.
6 changes: 3 additions & 3 deletions 5 - Sequence object/sequence.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ An array of audio tracks, within the sequence.

**Type**

Array; read-only; (TrackCollection object).
:ref:`trackCollection`, read-only;

----

Expand Down Expand Up @@ -132,7 +132,7 @@ The :ref:`Marker <marker>` objects associated with this sequence.

**Type**

Array; read-only; (MarkerCollection object).
:ref:`markerCollection`, read-only;

----

Expand Down Expand Up @@ -234,7 +234,7 @@ An array of video tracks, within the sequence.

**Type**

Array; read-only; (TrackCollection object).
:ref:`trackCollection`, read-only;

----

Expand Down
4 changes: 2 additions & 2 deletions 6 - Track object/track.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ An array of :ref:`Track item <trackItem>` objects, contained within the track, i

**Type**

Array; read-only; (TrackItemCollection object).
:ref:`trackItemCollection`, read-only;

----

Expand Down Expand Up @@ -104,7 +104,7 @@ An array of transitions objects, contained within the track, in temporal order.

**Type**

Array; read-only; (TrackItemCollection object).
:ref:`trackItemCollection`, read-only;

----

Expand Down
2 changes: 1 addition & 1 deletion 7 - TrackItem object/trackitem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The components associated with this trackItem. This can include intrinsic transf

**Type**

An Array of components; read-only; (ComponentCollection object).
:ref:`componentCollection`, read-only;

----

Expand Down

0 comments on commit 7015658

Please sign in to comment.