Inheritance diagram for DzMap:
enum DzMap::MapType |
The types of possible maps - each describes the type of values and dimension of the map.
DzMap::DzMap | ( | MapType | type = FLOAT_MAP |
) |
Constructor. Creates a new map of the given type.
type | The type of map to create |
void DzMap::appendFloatValue | ( | Number | val | ) |
Append a new value to the end of a float map This function is only valid for maps of FLOAT_MAP type.
val | The new value to append to the map. |
void DzMap::appendIntValue | ( | Number | val | ) |
Append a new value to the end of a integer map This function is only valid for maps of INT_MAP type.
val | The new value to append to the map. |
void DzMap::appendPnt2Vec | ( | DzVec3 | val | ) |
This function is provided for DAZ Script access to float 2 maps. It is considerably slower than appendPnt2Value(), so plugin developers should avoid using this function. This function is only valid for maps of FLOAT2_MAP type.
val | The value to append to the map. The z value of the vector is ignored. |
void DzMap::appendPnt3Vec | ( | DzVec3 | val | ) |
This function is provided for DAZ Script access to float 3 maps. It is considerably slower than appendPnt3Value(), so plugin developers should avoid using this function. This function is only valid for maps of FLOAT3_MAP type.
val | The value to append to the map. |
void DzMap::appendShortValue | ( | Number | val | ) |
Append a new value to the end of a short value map This function is only valid for maps of SHORT_MAP type.
val | The new value to append to the map. |
void DzMap::clearAllData | ( | ) |
Clears all map values. After this call, the number of values in the map will be zero.
This function is only valid for maps of FLOAT_MAP type.
This function is only valid for maps of INT_MAP type.
String DzMap::getLabel | ( | ) |
DzGeometry DzMap::getOrderingGeometry | ( | ) |
This function is only valid for maps of FLOAT2_MAP type.
This function is only valid for maps of FLOAT3_MAP type.
This function is only valid for maps of SHORT_MAP type.
MapType DzMap::getType | ( | ) |
void DzMap::labelChanged | ( | ) | [signal] |
Signature: "labelChanged()"
Emitted when the map's label changes
void DzMap::mapModified | ( | ) | [signal] |
Signature: "mapModified()"
Emitted whenever values are added, removed or modified on the map
void DzMap::setDefaultFloatValue | ( | Number | defaultVal | ) |
Sets the default value for a float map. This is the value returned if the map is empty or a map data value is requested that is outside the index range of this map. This function is only valid for maps of FLOAT_MAP type.
x | The new default value for the map. |
void DzMap::setDefaultIntValue | ( | Number | defaultVal | ) |
Sets the default value for an integer map. Thi is the value returned if the map is empty or a map data value is requested that is outside the index range of this map. This function is only valid for maps of INT_MAP type.
x | The new default value for the map. |
void DzMap::setDefaultPnt2Vec | ( | DzVec3 | defaultVal | ) |
This function is provided for DAZ Script access to float 2 maps. It is considerably slower than setDefaultPnt2Value(), so plugin developers should avoid using this function.
defaultVal | The default value of this map. The z value of the vector is ignored. |
void DzMap::setDefaultPnt3Vec | ( | DzVec3 | defaultVal | ) |
This function is provided for DAZ Script access to float 3 maps. It is considerably slower than setDefaultPnt3Value(), so plugin developers should avoid using this function.
defaultVal | The default value of this map. |
void DzMap::setDefaultShortValue | ( | Number | defaultVal | ) |
Sets the default value for a short value map. Thi is the value returned if the map is empty or a map data value is requested that is outside the index range of this map. This function is only valid for maps of SHORT_MAP type.
x | The new default value for the map. |
Set one of the currently existing data values on a float map This function is only valid for maps of FLOAT_MAP type.
idx | The index of the value to set. | |
val | The new value. |
Set one of the currently existing data values on a integer map This function is only valid for maps of INT_MAP type.
idx | The index of the entry to set | |
val | The value of this map for the given index. |
Changes the type of this map
mapType | The new type for the map | |
keepData | If true, the existing data will be converted to the new type as much as possible. If false, the existing data is lost, and the number of values in the map will be zero. |
void DzMap::setNumValues | ( | Number | num | ) |
Sets the size of the data array. Does not initialize newly allocated values.
num | The new number of values contained in the map. |
This function is only valid for maps of FLOAT2_MAP type.
idx | The index of the entry to set | |
val | The value of this map for the given index. The z value of the vector is ignored. |
This function is only valid for maps of FLOAT3_MAP type.
idx | The index of the entry to set | |
val | The value of this map for the given index. |
Set one of the currently existing data values on a short value map This function is only valid for maps of SHORT_MAP type.
idx | The index of the entry to set | |
val | The value of this map for the given index. |