vrdMaterialChunkList¶
-
class
vrdMaterialChunkList
¶
(Inherits vrdObjectList
)
This class is a container for the chunks of a chunk material.
Summary¶
- Functions:
- append(value)
- append(values)
- at(i) → vrdMaterialChunk
- canInsert(value) → bool
- clear()
- contains(value) → bool
- count(value) → integer
- create(type) → vrdMaterialChunk
- data() → List[vrdMaterialChunk]
- index(value, from, to) → integer
- insert(i, value)
- insert(i, values)
- move(from, to) → bool
- remove(value) → bool
- removeAll(value) → integer
- removeAt(i) → bool
- size() → integer
Functions¶
-
vrdMaterialChunkList.
append
(value)¶ Appends the value to this list.
Parameters: value (vrdMaterialChunk) – The value to append
-
vrdMaterialChunkList.
append
(values)¶ Appends the items of the value list to this list.
Parameters: values (List[vrdMaterialChunk]) – The values to append
-
vrdMaterialChunkList.
at
(i)¶ Get the value at the given index.
Parameters: i (integer) – Returns: i The index of the requested value Return type: vrdMaterialChunk
-
vrdMaterialChunkList.
canInsert
(value)¶ Check, if the given entry can be inserted.
Parameters: value (vrdMaterialChunk) – Returns: True, if insert is allowed Return type: bool
-
vrdMaterialChunkList.
clear
()¶ Removes all items from the list.
-
vrdMaterialChunkList.
contains
(value)¶ Check if an element is already in the list.
Parameters: value (vrdMaterialChunk) – Returns: True, if the given value is in this list Return type: bool
-
vrdMaterialChunkList.
count
(value)¶ Count the occurences of a given vlaue.
Parameters: value (vrdMaterialChunk) – Returns: The number of times the value has been found in the list Return type: integer
-
vrdMaterialChunkList.
create
(type)¶ Creates a chunk of the given type.
Parameters: type (ChunkType) – Returns: Return type: vrdMaterialChunk
-
vrdMaterialChunkList.
data
()¶ Get all entries of this list.
Returns: List of elements Return type: List[vrdMaterialChunk]
-
vrdMaterialChunkList.
index
(value, from=0, to=-1)¶ Returns the index of the given value.
Parameters: - value (vrdMaterialChunk) – The value to search
- from (integer) – The index to start the search, default is 0
- to (integer) – The index to end the search, default is -1 to search until the end
Returns: The index or -1, if not found
Return type: integer
-
vrdMaterialChunkList.
insert
(i, value)¶ Insert a value at a given position.
Parameters: - i (integer) – The position, starting from 0
- value (vrdMaterialChunk) – The value to be inserted
-
vrdMaterialChunkList.
insert
(i, values)¶ Insert values at a given position.
Parameters: - i (integer) – The position, starting from 0
- values (List[vrdMaterialChunk]) – The values to be inserted
-
vrdMaterialChunkList.
move
(from, to)¶ Moves a values inside the list.
Parameters: - from (integer) – The index to move
- to (integer) – The destination index
Returns: True on success, False otherwise
Return type: bool
-
vrdMaterialChunkList.
remove
(value)¶ Remove the first occurences of the given value.
Parameters: value (vrdMaterialChunk) – Returns: True, if the value has been removed Return type: bool
-
vrdMaterialChunkList.
removeAll
(value)¶ Remove all occurences of the given value.
Parameters: value (vrdMaterialChunk) – Returns: The number of value that have been removed Return type: integer
-
vrdMaterialChunkList.
removeAt
(i)¶ Remove a value from the list.
Parameters: i (integer) – Index of the value to be removed Returns: True, if the value has been removed Return type: bool
-
vrdMaterialChunkList.
size
()¶ Returns: Number of elements in this list. Return type: integer