FBPropertyListComponent Class Reference

b>PropertyList: Constraint More...

#include <pyfbsdk.h>

Inheritance diagram for FBPropertyListComponent:

Public Member Functions
int	__len__ ()
	Returns the number of elements.
FBComponent	__getitem__ (int pIndex)
	Returns the ith component Corresponds to python: print v[1].
	__setitem__ (int pIndex, FBComponent pComponentValue)
	Sets the ith components Corresponds to python: v[1] = my_component.
bool	__contains__ (FBComponent pComponent)
	Check if a FCComponent is already in PropertyList Corresponds to python: if object in propertyList:
	append (FBComponent pComp)
	Append new FBComponent at end of list.
int	count ()
	Returns the number of elements.
	insert (int pIndex, FBComponent pComp)
	Insert a new element in list.
	remove (int pIndex)
	Remove an element in list.
	removeAll ()
	Remove all elements of list.
FBComponent	pop ()
	Remove last element of list.
FBComponent	pop (int pIndex)
	Remove an element in list.
Public Member Functions inherited from FBPropertyList
int	__len__ ()
	Returns the number of elements.
Element	__getitem__ (int pIndex)
	Returns the ith component Corresponds to python: print l[1].
Public Member Functions inherited from FBProperty
	FBProperty ()
	Constructor.
bool	AllowsLocking ()
	AllowsLocking.
str	AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI)
	Get the property value as a string.
str	EnumList (int pIndex)
	Return the string of an enum value.
FBStringList	GetEnumStringList (bool pCreateIt=False)
	String list for enum properties.
float	GetMax ()
	GetMax.
float	GetMin ()
	GetMin.
str	GetName ()
	Get the property's name.
bool	GetPropertyFlag (FBFlag pFlag)
	GetPropertyFlag.
FBFlag	GetPropertyFlags ()
	GetPropertyFlags.
FBType	GetPropertyType ()
	Get the property's type.
str	GetPropertyTypeName ()
	Get the property's type name.
FBProperty	GetReferencedProperty ()
	Get the referenced property, in the case of this property is a reference property (see the IsReferenceProperty() method).
int	GetSubMemberCount ()
	GetSubMemberCount.
bool	HasSomethingLocked ()
	HasSomethingLocked.
bool	IsAnimatable ()
bool	IsInternal ()
bool	IsList ()
	Verify if property is of this type.
bool	IsLocked ()
	IsLocked.
bool	IsMaxClamp ()
	Indicate if maximum value clamping will be applied on user input value.
bool	IsMemberLocked (int pIndex)
	IsMemberLocked.
bool	IsMinClamp ()
	Indicate if minimum value clamping will be applied on user input value.
bool	IsObjectList ()
	Indicate if is an instance of FBPropertyListObject.
bool	IsReadOnly ()
	Is property read-only?
bool	IsReferenceProperty ()
bool	IsTextureConnectableProperty ()
bool	IsUserProperty ()
	ModifyPropertyFlag (FBFlag pFlag, bool pValue)
	ModifyPropertyFlag.
	NotifyEnumStringListChanged ()
	Notify system that the enum list was modified.
str	OriValueAsString ()
	Get the property original value (before any modification) as string.
	SetLocked (bool pLocked)
	SetLocked.
	SetMax (float pMax, bool pForceMaxClamp=False)
	SetMax.
	SetMemberLocked (int pIndex, bool pLocked)
	SetMemberLocked.
	SetMin (float pMin, bool pForceMinClamp=False)
	SetMin.
	SetName (str pName)
	Set the property's name.
bool	SetString (str pString)
	Set the property value from a string.

Additional Inherited Members
Public Attributes inherited from FBProperty
str	Name
	Read Property: The property's name.
object	Data
	Read Write Property: The property data value. Type of this depends on the subclass of FBProperty (ex: in a FBPropertyInt, Data is of type int).
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

b>PropertyList: Constraint

# Supported list protocol methods:    
 len(propertyListComponent)
 component= propertyListComponent[0]
 propertyListComponent[0] = my_component
 
 if my_component in propertyListComponent:
    print "it is contained!"
 
 del propertyListComponent[0]

Member Function Documentation

__contains__()

bool __contains__

(

FBComponent

pComponent

)

Check if a FCComponent is already in PropertyList Corresponds to python: if object in propertyList:

Parameters

pComponent

Component to check for inclusion

Returns

Is the Component contain or not?

__getitem__()

FBComponent __getitem__

(

int

pIndex

)

Returns the ith component Corresponds to python: print v[1].

Parameters

pIndex

Index of the components to get (0 to 2)

Returns

FBComponent component value.

__len__()

int __len__

(

)

Returns the number of elements.

Corresponds to python: len(object)

Returns

number of elements in list.

__setitem__()

__setitem__	(	int	pIndex,
		FBComponent	pComponentValue )

Sets the ith components Corresponds to python: v[1] = my_component.

Parameters

pIndex	Index of the components to set
pComponentValue	a FBComponent to set

append()

append

(

FBComponent

pComp

)

Append new FBComponent at end of list.

Parameters

pComp

to append

count()

int count

(

)

Returns the number of elements.

Corresponds to python: del propertyList[2]

Returns

number of elements in list.

insert()

insert	(	int	pIndex,
		FBComponent	pComp )

Insert a new element in list.

Parameters

pIndex	Index where to insert component
pComp	Component to append

pop() [1/2]

FBComponent pop

(

)

Remove last element of list.

Returns

Returns the element that was removed.

pop() [2/2]

FBComponent pop

(

int

pIndex

)

Remove an element in list.

Parameters

pIndex

Index where to remove element.

Returns

Returns the element that was removed.

remove()

remove

(

int

pIndex

)

Remove an element in list.

Parameters

pIndex

Index where to remove element.

removeAll()

removeAll

(

)

Remove all elements of list.