# class SceneNodeCollection

SceneNodeCollection holds a number of SceneNode objects. The objects can be looked up by their names (if they have been named through SetName()).

See also: ObjectCollection

# Methods

Method Description
AddObject Adds an object to the collection. The handle refers to the object until the object is removed from the collection again.
AddObjectSorted Adds an object to the collection, as AddObject, but sorts the object into the collection based on its name.
AddSceneNode Adds an object object to the collection. The handle refers to the object until it is removed from the collection again.
FindObject Finds a named object in the collection. The first object with this name is returned. The search is case-sensitive.
FindSceneNode Finds a named object.
GetClass Get the name of the SceneNodeCollection class.
GetFirstItem Returns the start of the collection. The handle returned refers to the first object in the collection. If the handle is null, then the collection is empty.
GetItem Returns the handle of the i:th item.
GetItemAsObject Returns the object of the i:th item.
GetItemCount The number of items in the collection.
GetItemsObject The object the handle is referring to.
GetNextItem Returns the handle to the next item in the collection. Use GetFirstItem and this method to step through the collection. If the return is null, the end of the collection has been reached.
GetNextItemAsSceneNode Returns the object of the next item.
GetSceneNode The object the handle is referring to.
IsA Returns true if SceneNodeCollection is a or is a descendant of the class named as the type parameter.
IsItemInCollection Returns true if the item is in the collection.
IsNull Returns true if the SceneNodeCollection object is invalid.
IsObjectInCollection Returns true if the object is in the collection.
IsSceneNodeInCollection Returns true if the object is in the collection.
RemoveAllItems Removes all items from the collection.
RemoveItem Removes an item from the collection. The handle returned is the first item after this item that is in the collection. If the return is null, the item was the last item in the collection. Warning! The handle is invalid after the removal of the object.
RemoveObject Removes an object from the collection. Only the first occurance of the object is removed from the collection.
RemoveSceneNode Removes an object from the collection. Only the first occurrence of the object is removed.

# Static methods

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
SafeCast SafeCast makes sure the input object is of a class that can be cast into spSceneNodeCollection, and if this is the case, returns the object cast into spSceneNodeCollection.

# Methods details

# AddObject

Adds an object to the collection. The handle refers to the object until the object is removed from the collection again.

    # AddObjectSorted

    Adds an object to the collection, as AddObject, but sorts the object into the collection based on its name.

      # AddSceneNode

      Adds an object object to the collection. The handle refers to the object until it is removed from the collection again.

        # FindObject

        Finds a named object in the collection. The first object with this name is returned. The search is case-sensitive.

          # FindSceneNode

          Finds a named object.

            # GetClass

            Get the name of the SceneNodeCollection class.

              # GetFirstItem

              Returns the start of the collection. The handle returned refers to the first object in the collection. If the handle is null, then the collection is empty.

                # GetItem

                Returns the handle of the i:th item.

                  # GetItemAsObject

                  Returns the object of the i:th item.

                    # GetItemCount

                    The number of items in the collection.

                      # GetItemsObject

                      The object the handle is referring to.

                        # GetNextItem

                        Returns the handle to the next item in the collection. Use GetFirstItem and this method to step through the collection. If the return is null, the end of the collection has been reached.

                          # GetNextItemAsSceneNode

                          Returns the object of the next item.

                            # GetSceneNode

                            The object the handle is referring to.

                              # IsA

                              Returns true if SceneNodeCollection is a or is a descendant of the class named as the type parameter.

                                # IsItemInCollection

                                Returns true if the item is in the collection.

                                  # IsNull

                                  Returns true if the SceneNodeCollection object is invalid.

                                    # IsObjectInCollection

                                    Returns true if the object is in the collection.

                                      # IsSceneNodeInCollection

                                      Returns true if the object is in the collection.

                                        # RemoveAllItems

                                        Removes all items from the collection.

                                          # RemoveItem

                                          Removes an item from the collection. The handle returned is the first item after this item that is in the collection. If the return is null, the item was the last item in the collection. Warning! The handle is invalid after the removal of the object.

                                            # RemoveObject

                                            Removes an object from the collection. Only the first occurance of the object is removed from the collection.

                                              # RemoveSceneNode

                                              Removes an object from the collection. Only the first occurrence of the object is removed.

                                                # Static methods details

                                                # IsClassA

                                                Returns true if the class is a or is a descendant of the class named as the type parameter.

                                                  # SafeCast

                                                  SafeCast makes sure the input object is of a class that can be cast into spSceneNodeCollection, and if this is the case, returns the object cast into spSceneNodeCollection.