Inherits AssetBase, and AssetBase.
Methods | |
| bool | addExplicitCell (int cellOffsetX, int cellOffsetY, int cellWidth, int cellHeight) |
| bool | addExplicitCell (int cellOffsetX, int cellOffsetY, int cellWidth, int cellHeight) |
| bool | clearExplicitCells () |
| bool | clearExplicitCells () |
| int | getCellCountX () |
| int | getCellCountX () |
| int | getCellCountY () |
| int | getCellCountY () |
| int | getCellHeight () |
| int | getCellHeight () |
| int | getCellOffsetX () |
| int | getCellOffsetX () |
| int | getCellOffsetY () |
| int | getCellOffsetY () |
| bool | getCellRowOrder () |
| bool | getCellRowOrder () |
| int | getCellStrideX () |
| int | getCellStrideX () |
| int | getCellStrideY () |
| int | getCellStrideY () |
| int | getCellWidth () |
| int | getCellWidth () |
| int | getExplicitCellCount () |
| int | getExplicitCellCount () |
| string | getFilterMode () |
| string | getFilterMode () |
| bool | getForce16Bit () |
| bool | getForce16Bit () |
| int | getFrameCount () |
| int | getFrameCount () |
| string | getFrameSize (int frame) |
| string | getFrameSize (int frame) |
| string | getImageFile () |
| string | getImageFile () |
| int | getImageHeight () |
| int | getImageHeight () |
| string | getImageSize () |
| string | getImageSize () |
| int | getImageWidth () |
| int | getImageWidth () |
| bool | getIsImagePOT () |
| bool | getIsImagePOT () |
| bool | insertExplicitCell (int cellIndex, int cellOffsetX, int cellOffsetY, int cellWidth, int cellHeight) |
| bool | insertExplicitCell (int cellIndex, int cellOffsetX, int cellOffsetY, int cellWidth, int cellHeight) |
| bool | removeExplicitCell (int cellIndex) |
| bool | removeExplicitCell (int cellIndex) |
| void | setCellCountX (countX) |
| void | setCellCountX (countX) |
| void | setCellCountY (countY) |
| void | setCellCountY (countY) |
| void | setCellHeight (Height) |
| void | setCellHeight (Height) |
| void | setCellOffsetX (offsetX) |
| void | setCellOffsetX (offsetX) |
| void | setCellOffsetY (offsetY) |
| void | setCellOffsetY (offsetY) |
| void | setCellRowOrder (rowOrder?) |
| void | setCellRowOrder (rowOrder?) |
| void | setCellStrideX (strideX) |
| void | setCellStrideX (strideX) |
| void | setCellStrideY (strideY) |
| void | setCellStrideY (strideY) |
| void | setCellWidth (Width) |
| void | setCellWidth (Width) |
| bool | setExplicitCell (int cellIndex, int cellOffsetX, int cellOffsetY, int cellWidth, int cellHeight) |
| bool | setExplicitCell (int cellIndex, int cellOffsetX, int cellOffsetY, int cellWidth, int cellHeight) |
| void | setFilterMode (mode) |
| void | setFilterMode (mode) |
| void | setForce16Bit (force16Bit?) |
| void | setForce16Bit (force16Bit?) |
| void | setImageFile (ImageFile) |
| void | setImageFile (ImageFile) |
 Methods inherited from AssetBase | |
| string | getAssetId () |
| string | getAssetId () |
| void | refreshAsset () |
| void | refreshAsset () |
| Methods inherited from SimObject | |
| void | addFieldFilter (fieldName) |
| void | addFieldFilter (fieldName) |
| string | call (%args) |
| string | call (%args) |
| int | clone ([bool copyDynamicFields?=false]) |
| int | clone ([bool copyDynamicFields?=false]) |
| void | delete () |
| void | delete () |
| void | dump () |
| void | dump () |
| void | dumpClassHierarchy () |
| void | dumpClassHierarchy () |
| string | getClassName () |
| string | getClassName () |
| string | getClassNamespace () |
| string | getClassNamespace () |
| string | getDynamicField (index) |
| string | getDynamicField (index) |
| int | getDynamicFieldCount () |
| int | getDynamicFieldCount () |
| string | getField (int index) |
| string | getField (int index) |
| int | getFieldCount () |
| int | getFieldCount () |
| string | getFieldType (fieldName) |
| string | getFieldType (fieldName) |
| string | getFieldValue (fieldName) |
| string | getFieldValue (fieldName) |
| int | getGroup () |
| int | getGroup () |
| int | getId () |
| int | getId () |
| string | getInternalName () |
| string | getInternalName () |
| string | getName () |
| string | getName () |
| string | getProgenitorFile () |
| string | getProgenitorFile () |
| string | getSuperClassNamespace () |
| string | getSuperClassNamespace () |
| int | getType () |
| int | getType () |
| bool | isChildOfGroup () |
| bool | isChildOfGroup () |
| bool | isMemberOfClass (string classname) |
| bool | isMemberOfClass (string classname) |
| bool | isMethod (string method name) |
| bool | isMethod (string method name) |
| bool | isTimerActive () |
| bool | isTimerActive () |
| void | removeFieldFilter (fieldName) |
| void | removeFieldFilter (fieldName) |
| bool | save (fileName,[selectedOnly]) |
| bool | save (fileName,[selectedOnly]) |
| int | schedule (time, command,< arg1...argN >) |
| int | schedule (time, command,< arg1...argN >) |
| void | setClassNamespace () |
| void | setClassNamespace () |
| bool | setFieldValue (fieldName, value) |
| bool | setFieldValue (fieldName, value) |
| void | setInternalName () |
| void | setInternalName () |
| void | setName (newName) |
| void | setName (newName) |
| void | setProgenitorFile (file) |
| void | setProgenitorFile (file) |
| void | setSuperClassNamespace () |
| void | setSuperClassNamespace () |
| bool | startTimer (callbackFunction, float timePeriod,[repeat]) |
| bool | startTimer (callbackFunction, float timePeriod,[repeat]) |
| void | stopTimer () |
| void | stopTimer () |
Fields | |
| bool | AssetAutoUnload |
| string | AssetCategory |
| string | AssetDescription |
| bool | AssetInternal |
| string | AssetName |
| bool | AssetPrivate |
| int | CellCountX |
| int | CellCountY |
| int | CellHeight |
| int | CellOffsetX |
| int | CellOffsetY |
| bool | CellRowOrder |
| int | CellStrideX |
| int | CellStrideY |
| int | CellWidth |
| bool | ExplicitMode |
| enumval | FilterMode |
| bool | Force16bit |
| assetLooseFilePath | ImageFile |
SimBase | |
| bool | canSaveDynamicFields |
| string | internalName |
| SimObjectPtr | parentGroup |
Namespace Linking | |
| string | superclass |
| string | class |
| Fields inherited from AssetBase | |
| bool | AssetAutoUnload |
| string | AssetCategory |
| string | AssetDescription |
| bool | AssetInternal |
| string | AssetName |
| bool | AssetPrivate |
| bool | canSaveDynamicFields |
| string | internalName |
| SimObjectPtr | parentGroup |
| string | superclass |
| string | class |
| Fields inherited from SimObject | |
| bool | canSaveDynamicFields |
| string | internalName |
| SimObjectPtr | parentGroup |
| string | superclass |
| string | class |
Methods
| bool ImageAsset::addExplicitCell | ( | int | cellOffsetX, |
| int | cellOffsetY, | ||
| int | cellWidth, | ||
| int | cellHeight | ||
| ) |
Add an explicit cell.
- Parameters
-
cellOffsetX The offset in the X axis to the top-left of the cell. cellOffsetY The offset in the Y axis to the top-left of the cell. cellWidth The width of the cell. cellHeight The height of the cell. The image asset must be in explicit mode for this operation to succeed.
- Returns
- Whether the operation was successful or not.
| bool ImageAsset::addExplicitCell | ( | int | cellOffsetX, |
| int | cellOffsetY, | ||
| int | cellWidth, | ||
| int | cellHeight | ||
| ) |
Add an explicit cell.
- Parameters
-
cellOffsetX The offset in the X axis to the top-left of the cell. cellOffsetY The offset in the Y axis to the top-left of the cell. cellWidth The width of the cell. cellHeight The height of the cell. The image asset must be in explicit mode for this operation to succeed.
- Returns
- Whether the operation was successful or not.
| bool ImageAsset::clearExplicitCells | ( | ) |
Clears all explicit cells. The image asset stays in explicit mode however with no explicit cells a single full-frame cell becomes default.
- Returns
- Whether the operation was successful or not.
| bool ImageAsset::clearExplicitCells | ( | ) |
Clears all explicit cells. The image asset stays in explicit mode however with no explicit cells a single full-frame cell becomes default.
- Returns
- Whether the operation was successful or not.
| int ImageAsset::getCellCountX | ( | ) |
Gets the CELL count X.
- Returns
- The CELL count X.
| int ImageAsset::getCellCountX | ( | ) |
Gets the CELL count X.
- Returns
- The CELL count X.
| int ImageAsset::getCellCountY | ( | ) |
Gets the CELL count Y.
- Returns
- The CELL count Y.
| int ImageAsset::getCellCountY | ( | ) |
Gets the CELL count Y.
- Returns
- The CELL count Y.
| int ImageAsset::getCellHeight | ( | ) |
Gets the CELL height.
- Returns
- The CELL height.
| int ImageAsset::getCellHeight | ( | ) |
Gets the CELL height.
- Returns
- The CELL height.
| int ImageAsset::getCellOffsetX | ( | ) |
Gets the CELL offset X.
- Returns
- The CELL offset X.
| int ImageAsset::getCellOffsetX | ( | ) |
Gets the CELL offset X.
- Returns
- The CELL offset X.
| int ImageAsset::getCellOffsetY | ( | ) |
Gets the CELL offset Y.
- Returns
- The CELL offset Y.
| int ImageAsset::getCellOffsetY | ( | ) |
Gets the CELL offset Y.
- Returns
- The CELL offset Y.
| bool ImageAsset::getCellRowOrder | ( | ) |
Gets whether CELL row order should be used or not.
- Returns
- Whether CELL row order should be used or not.
| bool ImageAsset::getCellRowOrder | ( | ) |
Gets whether CELL row order should be used or not.
- Returns
- Whether CELL row order should be used or not.
| int ImageAsset::getCellStrideX | ( | ) |
Gets the CELL stride X.
- Returns
- The CELL stride X.
| int ImageAsset::getCellStrideX | ( | ) |
Gets the CELL stride X.
- Returns
- The CELL stride X.
| int ImageAsset::getCellStrideY | ( | ) |
Gets the CELL stride Y.
- Returns
- The CELL stride Y.
| int ImageAsset::getCellStrideY | ( | ) |
Gets the CELL stride Y.
- Returns
- The CELL stride Y.
| int ImageAsset::getCellWidth | ( | ) |
Gets the CELL width.
- Returns
- The CELL width.
| int ImageAsset::getCellWidth | ( | ) |
Gets the CELL width.
- Returns
- The CELL width.
| int ImageAsset::getExplicitCellCount | ( | ) |
Gets the explicit cell count.
- Returns
- The explicit cell count.
| int ImageAsset::getExplicitCellCount | ( | ) |
Gets the explicit cell count.
- Returns
- The explicit cell count.
| string ImageAsset::getFilterMode | ( | ) |
Gets the filter mode.
- Returns
- The filter mode.
| string ImageAsset::getFilterMode | ( | ) |
Gets the filter mode.
- Returns
- The filter mode.
| bool ImageAsset::getForce16Bit | ( | ) |
Gets whether 16-bit image is forced or not.
- Returns
- Whether 16-bit image is forced or not.
| bool ImageAsset::getForce16Bit | ( | ) |
Gets whether 16-bit image is forced or not.
- Returns
- Whether 16-bit image is forced or not.
| int ImageAsset::getFrameCount | ( | ) |
Gets the frame count.
- Returns
- The frame count.
| int ImageAsset::getFrameCount | ( | ) |
Gets the frame count.
- Returns
- The frame count.
| string ImageAsset::getFrameSize | ( | int | frame | ) |
- Gets the specified frames size.
- Parameters
-
frame The frame number to use.
- Returns
- The specified frames size.
| string ImageAsset::getFrameSize | ( | int | frame | ) |
- Gets the specified frames size.
- Parameters
-
frame The frame number to use.
- Returns
- The specified frames size.
| string ImageAsset::getImageFile | ( | ) |
Gets the image file.
- Returns
- Returns the bitmap image file.
| string ImageAsset::getImageFile | ( | ) |
Gets the image file.
- Returns
- Returns the bitmap image file.
| int ImageAsset::getImageHeight | ( | ) |
Gets the image height.
- Returns
- The image width.
| int ImageAsset::getImageHeight | ( | ) |
Gets the image height.
- Returns
- The image width.
| string ImageAsset::getImageSize | ( | ) |
Gets the image size.
- Returns
- The image size.
| string ImageAsset::getImageSize | ( | ) |
Gets the image size.
- Returns
- The image size.
| int ImageAsset::getImageWidth | ( | ) |
Gets the image width.
- Returns
- The image width.
| int ImageAsset::getImageWidth | ( | ) |
Gets the image width.
- Returns
- The image width.
| bool ImageAsset::getIsImagePOT | ( | ) |
Gets whether the image has a power-of-two dimensions or not.
- Returns
- Whether the image has a power-of-two dimensions or not.
| bool ImageAsset::getIsImagePOT | ( | ) |
Gets whether the image has a power-of-two dimensions or not.
- Returns
- Whether the image has a power-of-two dimensions or not.
| bool ImageAsset::insertExplicitCell | ( | int | cellIndex, |
| int | cellOffsetX, | ||
| int | cellOffsetY, | ||
| int | cellWidth, | ||
| int | cellHeight | ||
| ) |
Insert an explicit cell at the specified index.
- Parameters
-
cellIndex The zero-based index to insert the cell. This will work when no cells are present. If the index is beyond the cell count then the cell is simply added. cellOffsetX The offset in the X axis to the top-left of the cell. cellOffsetY The offset in the Y axis to the top-left of the cell. cellWidth The width of the cell. cellHeight The height of the cell. The image asset must be in explicit mode for this operation to succeed.
- Returns
- Whether the operation was successful or not.
| bool ImageAsset::insertExplicitCell | ( | int | cellIndex, |
| int | cellOffsetX, | ||
| int | cellOffsetY, | ||
| int | cellWidth, | ||
| int | cellHeight | ||
| ) |
Insert an explicit cell at the specified index.
- Parameters
-
cellIndex The zero-based index to insert the cell. This will work when no cells are present. If the index is beyond the cell count then the cell is simply added. cellOffsetX The offset in the X axis to the top-left of the cell. cellOffsetY The offset in the Y axis to the top-left of the cell. cellWidth The width of the cell. cellHeight The height of the cell. The image asset must be in explicit mode for this operation to succeed.
- Returns
- Whether the operation was successful or not.
| bool ImageAsset::removeExplicitCell | ( | int | cellIndex | ) |
Remove an explicit cell from the specified index.
- Parameters
-
cellIndex The zero-based index to remove the cell from.
- Returns
- Whether the operation was successful or not.
| bool ImageAsset::removeExplicitCell | ( | int | cellIndex | ) |
Remove an explicit cell from the specified index.
- Parameters
-
cellIndex The zero-based index to remove the cell from.
- Returns
- Whether the operation was successful or not.
| void ImageAsset::setCellCountX | ( | countX | ) |
Sets the CELL count X.
- Returns
- No return value.
| void ImageAsset::setCellCountX | ( | countX | ) |
Sets the CELL count X.
- Returns
- No return value.
| void ImageAsset::setCellCountY | ( | countY | ) |
Sets the CELL count Y.
- Returns
- No return value.
| void ImageAsset::setCellCountY | ( | countY | ) |
Sets the CELL count Y.
- Returns
- No return value.
| void ImageAsset::setCellHeight | ( | Height | ) |
Sets the CELL height.
- Returns
- No return value.
| void ImageAsset::setCellHeight | ( | Height | ) |
Sets the CELL height.
- Returns
- No return value.
| void ImageAsset::setCellOffsetX | ( | offsetX | ) |
Sets the CELL offset X.
- Returns
- No return value.
| void ImageAsset::setCellOffsetX | ( | offsetX | ) |
Sets the CELL offset X.
- Returns
- No return value.
| void ImageAsset::setCellOffsetY | ( | offsetY | ) |
Sets the CELL offset Y.
- Returns
- No return value.
| void ImageAsset::setCellOffsetY | ( | offsetY | ) |
Sets the CELL offset Y.
- Returns
- No return value.
| void ImageAsset::setCellRowOrder | ( | rowOrder? | ) |
Sets whether CELL row order should be used or not.
- Returns
- No return value.
| void ImageAsset::setCellRowOrder | ( | rowOrder? | ) |
Sets whether CELL row order should be used or not.
- Returns
- No return value.
| void ImageAsset::setCellStrideX | ( | strideX | ) |
Sets the CELL stride X.
- Returns
- No return value.
| void ImageAsset::setCellStrideX | ( | strideX | ) |
Sets the CELL stride X.
- Returns
- No return value.
| void ImageAsset::setCellStrideY | ( | strideY | ) |
Sets the CELL stride Y.
- Returns
- No return value.
| void ImageAsset::setCellStrideY | ( | strideY | ) |
Sets the CELL stride Y.
- Returns
- No return value.
| void ImageAsset::setCellWidth | ( | Width | ) |
Sets the CELL width.
- Returns
- No return value.
| void ImageAsset::setCellWidth | ( | Width | ) |
Sets the CELL width.
- Returns
- No return value.
| bool ImageAsset::setExplicitCell | ( | int | cellIndex, |
| int | cellOffsetX, | ||
| int | cellOffsetY, | ||
| int | cellWidth, | ||
| int | cellHeight | ||
| ) |
Set an explicit cell at the specified index.
- Parameters
-
cellIndex The zero-based index to insert the cell. This will work when no cells are present. If the index is beyond the cell count then the cell is simply added. cellOffsetX The offset in the X axis to the top-left of the cell. cellOffsetY The offset in the Y axis to the top-left of the cell. cellWidth The width of the cell. cellHeight The height of the cell. The image asset must be in explicit mode for this operation to succeed.
- Returns
- Whether the operation was successful or not.
| bool ImageAsset::setExplicitCell | ( | int | cellIndex, |
| int | cellOffsetX, | ||
| int | cellOffsetY, | ||
| int | cellWidth, | ||
| int | cellHeight | ||
| ) |
Set an explicit cell at the specified index.
- Parameters
-
cellIndex The zero-based index to insert the cell. This will work when no cells are present. If the index is beyond the cell count then the cell is simply added. cellOffsetX The offset in the X axis to the top-left of the cell. cellOffsetY The offset in the Y axis to the top-left of the cell. cellWidth The width of the cell. cellHeight The height of the cell. The image asset must be in explicit mode for this operation to succeed.
- Returns
- Whether the operation was successful or not.
| void ImageAsset::setFilterMode | ( | mode | ) |
Sets the filter mode.
- Returns
- No return value.
| void ImageAsset::setFilterMode | ( | mode | ) |
Sets the filter mode.
- Returns
- No return value.
| void ImageAsset::setForce16Bit | ( | force16Bit? | ) |
Sets whether 16-bit image is forced or not.
- Returns
- No return value.
| void ImageAsset::setForce16Bit | ( | force16Bit? | ) |
Sets whether 16-bit image is forced or not.
- Returns
- No return value.
| void ImageAsset::setImageFile | ( | ImageFile | ) |
Sets the image file (bitmap file).
- Returns
- No return value.
| void ImageAsset::setImageFile | ( | ImageFile | ) |
Sets the image file (bitmap file).
- Returns
- No return value.
Member Data Documentation
| bool ImageAsset::AssetAutoUnload |
Whether the asset is automatically unloaded when an asset is released and has no other acquisitions or not.
| string ImageAsset::AssetCategory |
An arbitrary category that can be used to categorized assets.
| string ImageAsset::AssetDescription |
The simple description of the asset contents.
| bool ImageAsset::AssetInternal |
Whether the asset is used internally only or not.
| string ImageAsset::AssetName |
The name of the asset. The is not a unique identification like an asset Id.
| bool ImageAsset::AssetPrivate |
Whether the asset is private or not.
| bool ImageAsset::canSaveDynamicFields |
| int ImageAsset::CellCountX |
| int ImageAsset::CellCountY |
| int ImageAsset::CellHeight |
| int ImageAsset::CellOffsetX |
| int ImageAsset::CellOffsetY |
| bool ImageAsset::CellRowOrder |
| int ImageAsset::CellStrideX |
| int ImageAsset::CellStrideY |
| int ImageAsset::CellWidth |
| string ImageAsset::class |
Script SuperClass of object.
| bool ImageAsset::ExplicitMode |
| enumval ImageAsset::FilterMode |
| bool ImageAsset::Force16bit |
| assetLooseFilePath ImageAsset::ImageFile |
| string ImageAsset::internalName |
| SimObjectPtr ImageAsset::parentGroup |
Group hierarchy parent of the object.
| string ImageAsset::superclass |
Script Class of object.