Detailed Description
List of scene objects.
This list is a more generic container often used as object properties. The types of actual object that it can contain can be specialised.
Definition at line 467 of file fbcomponent.h.
#include <fbcomponent.h>
Public Member Functions |
|
| FBPropertyListObject () | |
| Constructor. |
|
| virtual int | GetCount () |
| Get the object count. |
|
| virtual int | Add (FBComponent *pObject) |
| Add an object at the end of the list.
|
|
| virtual int | SetAt (int pIndex, FBComponent *pObject) |
| Replace an existing entry at a specific
index. |
|
| virtual void | RemoveAt (int pIndex) |
| Remove an object at a specific index.
|
|
| virtual int | InsertAt (int pIndex, FBComponent *pObject) |
| Insert an object at a specific index.
|
|
| virtual void | Clear () |
| Clears the content of the list. |
|
| virtual void | SetSingleConnect (bool pSingleConnect) |
| Set if the connection is single or multiple.
|
|
| virtual int | GetSingleConnect () |
| Get if the connection support only one
connection. |
|
| void | SetFilter (int pInternalClassId) |
| Set the filter connections to the property
list (UI only). |
|
| int | GetFilter () |
| Get the filter class Id for the property
list (UI only). |
|
| virtual FBComponent * | operator[] (int pIndex) |
| Get the object at pIndex. |
|
| virtual FBComponent * | GetAt (int pIndex) |
| Get the Component at pIndex.
|
|
Constructor & Destructor Documentation
Constructor.
Member Function Documentation
| virtual int GetCount | ( | ) | [virtual] |
| virtual FBComponent* operator[] | ( | int | pIndex | ) | [virtual] |
Get the object at pIndex.
- Parameters:
-
pIndex Index of the object to query.
- Returns:
- The object at pIndex.
Reimplemented from FBPropertyListComponentBase.
| virtual FBComponent* GetAt | ( | int | pIndex | ) | [virtual] |
Get the Component at pIndex.
- Parameters:
-
pIndex Index of Component to get a handle on.
- Returns:
- Component at pIndex.
Reimplemented from FBPropertyListComponent.
| virtual int Add | ( | FBComponent * | pObject | ) | [virtual] |
Add an object at the end of the list.
- Parameters:
-
pObject Object to add to list.
- Returns:
- Index of the newly added object. A return value of '-1' indicated the the object has not been added.
Reimplemented from FBPropertyListComponentBase.
| virtual int SetAt | ( | int | pIndex, |
| FBComponent * | pObject | ||
| ) | [virtual] |
Replace an existing entry at a specific index.
- Parameters:
-
pIndex Index of the object that should be replaced. pObject Object to insert in the list.
- Returns:
- Index of the replaced object. A return value of '-1' indicated the the object has not been replaced.
| virtual void RemoveAt | ( | int | pIndex | ) | [virtual] |
Remove an object at a specific index.
- Parameters:
-
pIndex Index of the object that should be removed.
Reimplemented from FBPropertyListComponentBase.
| virtual int InsertAt | ( | int | pIndex, |
| FBComponent * | pObject | ||
| ) | [virtual] |
Insert an object at a specific index.
- Parameters:
-
pIndex Index where the object should be inserted. pObject Object to insert in the list.
- Returns:
- Index of the inserted object. A return value of '-1' indicated the the object has not been inserted.
| virtual void Clear | ( | ) | [virtual] |
Clears the content of the list.
| virtual void SetSingleConnect | ( | bool | pSingleConnect | ) | [virtual] |
Set if the connection is single or multiple.
- Parameters:
-
pSingleConnect set to true for only one connection allowed.
| virtual int GetSingleConnect | ( | ) | [virtual] |
Get if the connection support only one connection.
- Returns:
- true is the connection support only one connection.
| void SetFilter | ( | int | pInternalClassId | ) |
Set the filter connections to the property list (UI only).
- Parameters:
-
pInternalClassId used for filtering connections; should be taken from object::GetInternalClassId() (-1 equal no filter).
| int GetFilter | ( | ) |
Get the filter class Id for the property list (UI only).
- Returns:
- MBClassId used for filtering connections (-1 equal no filter).
The documentation for this class was generated from the following file:
- fbsdk/fbcomponent.h
