All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.std.movies.media.SpriteMediaHandler

java.lang.Object
   |
   +----quicktime.QTObject
           |
           +----quicktime.std.comp.ComponentIdentifier
                   |
                   +----quicktime.std.comp.Component
                           |
                           +----quicktime.std.movies.media.MediaHandler
                                   |
                                   +----quicktime.std.movies.media.VisualMediaHandler
                                           |
                                           +----quicktime.std.movies.media.SpriteMediaHandler

public final class SpriteMediaHandler
extends VisualMediaHandler
implements QuickTimeLib

Method Index

 o countImages()
This method returns the number of images contained in the image pool of this media.
 o countSprites()
This method returns the number of sprites contained in the media.
 o getActionVariable(int)
Returns the value of the sprite track variable with specified ID.
 o getDisplayedSampleNumber()
This method returns the sample number displayed currently.
 o getGraphicsMode(int)
This method allows you to get the graphics mode property of a sprite.
 o getImageIndex(int)
This method allows you to get the image index property of a sprite.
 o getImageName(int)
Returns the name of the sprite with the specified ID.
 o getIndImageDescription(int)
This method returns the image description for the image specified by the index.
 o getLayer(int)
This method allows you to get the layer property of a sprite.
 o getMatrix(int)
This method allows you to get the matrix property of a sprite.
 o getSpriteImageGroupID(int)
Returns a propert value for the image specified by imageIndex.
 o getSpriteImageRegistrationPoint(int)
Returns a propert value for the image specified by imageIndex.
 o getSpriteName(int)
Returns the name of the sprite with the specified ID.
 o getVisible(int)
This method allows you to get the visibility property of a sprite.
 o hitTestAllSprites(int, QDPoint)
This method allows you to receive the index of the sprite which contains a specified point.
 o hitTestOneSprite(int, int, QDPoint)
Perform hit testing on the sprite specified by loc.
 o setActionVariable(int, float)
Sets the value of the sprite track variable with the ID of the variable to the supplied value.
 o setGraphicsMode(int, GraphicsMode)
This method allows you to specify the graphics mode property of a sprite.
 o setImageIndex(int, int)
This method allows you to specify the image index property of a sprite.
 o setLayer(int, int)
This method allows you to specify the layer property of a sprite.
 o setMatrix(int, Matrix)
This method allows you to specify the Matrix property of a sprite.
 o setVisible(int, boolean)
This method allows you to specify the visibility property of a sprite.
 o spriteIDtoIndex(int)
Return the index of the sprite specified by spriteID.
 o spriteIndexToID(int)
Return the ID of the sprite specified by spriteIndex.

Methods

 o setMatrix
 public void setMatrix(int spriteID,
                       Matrix matrix) throws StdQTException
This method allows you to specify the Matrix property of a sprite.

QuickTime::SpriteMediaSetSpriteProperty()

Parameters:
spriteID - Specifies the sprite ID.
matrix - Specifies the new matrix.
 o setVisible
 public void setVisible(int spriteID,
                        boolean visible) throws StdQTException
This method allows you to specify the visibility property of a sprite.

QuickTime::SpriteMediaSetSpriteProperty()

Parameters:
spriteID - Specifies the sprite ID.
visible - Specifies the new visibility property.
 o setLayer
 public void setLayer(int spriteID,
                      int layer) throws StdQTException
This method allows you to specify the layer property of a sprite.

QuickTime::SpriteMediaSetSpriteProperty()

Parameters:
spriteID - Specifies the sprite ID.
layer - Specifies the new layer property.
 o setGraphicsMode
 public void setGraphicsMode(int spriteID,
                             GraphicsMode gMode) throws StdQTException
This method allows you to specify the graphics mode property of a sprite.

QuickTime::SpriteMediaSetSpriteProperty()

Parameters:
spriteID - Specifies the sprite ID.
gMode - Specifies the new graphics mode property.
 o setImageIndex
 public void setImageIndex(int spriteID,
                           int index) throws StdQTException
This method allows you to specify the image index property of a sprite.

QuickTime::SpriteMediaSetSpriteProperty()

Parameters:
spriteID - Specifies the sprite ID.
index - Specifies the new image index property.
 o getMatrix
 public Matrix getMatrix(int spriteID) throws StdQTException
This method allows you to get the matrix property of a sprite.

QuickTime::SpriteMediaGetSpriteProperty()

Parameters:
spriteID - Specifies the sprite ID.
Returns:
the matrix property of the specified sprite.
 o getVisible
 public boolean getVisible(int spriteID) throws StdQTException
This method allows you to get the visibility property of a sprite.

QuickTime::SpriteMediaGetSpriteProperty()

Parameters:
spriteID - Specifies the sprite ID.
Returns:
the visibility property of the specified sprite.
 o getLayer
 public int getLayer(int spriteID) throws StdQTException
This method allows you to get the layer property of a sprite.

QuickTime::SpriteMediaGetSpriteProperty()

Parameters:
spriteID - Specifies the sprite ID.
Returns:
the layer property of the specified sprite.
 o getGraphicsMode
 public GraphicsMode getGraphicsMode(int spriteID) throws StdQTException
This method allows you to get the graphics mode property of a sprite.

QuickTime::SpriteMediaGetSpriteProperty()

Parameters:
spriteID - Specifies the sprite ID.
Returns:
the graphics mode property of the specified sprite.
 o getImageIndex
 public int getImageIndex(int spriteID) throws StdQTException
This method allows you to get the image index property of a sprite.

QuickTime::SpriteMediaGetSpriteProperty()

Parameters:
spriteID - Specifies the sprite ID.
Returns:
the image index property of the specified sprite.
 o hitTestAllSprites
 public int hitTestAllSprites(int flags,
                              QDPoint loc) throws StdQTException
This method allows you to receive the index of the sprite which contains a specified point.

QuickTime::SpriteMediaHitTestAllSprites()

Parameters:
flags - Controls the operation of this method.
loc - Specifies the point for hit test.
Returns:
the ID of the sprite which contains the point.
 o hitTestOneSprite
 public boolean hitTestOneSprite(int spriteID,
                                 int flags,
                                 QDPoint loc) throws StdQTException
Perform hit testing on the sprite specified by loc.

QuickTime::SpriteMediaHitTestOneSprite()

Parameters:
spriteID - Specifies the sprite ID.
flags - specifies how to control the hit testing operation
loc - Specifies the point for hit test.
Returns:
true or false if the loc matches that of the sprite.
 o countSprites
 public int countSprites() throws StdQTException
This method returns the number of sprites contained in the media.

QuickTime::SpriteMediaCountSprites()

Returns:
the number of sprites contained in the media.
 o countImages
 public int countImages() throws StdQTException
This method returns the number of images contained in the image pool of this media.

QuickTime::SpriteMediaCountImages()

Returns:
the number of images.
 o getIndImageDescription
 public ImageDescription getIndImageDescription(int imageIndex) throws QTException
This method returns the image description for the image specified by the index.

QuickTime::SpriteMediaGetIndImageDescription()

Parameters:
imageIndex - Specifies the image index.
Returns:
the image description for the image specified by the index.
 o getDisplayedSampleNumber
 public int getDisplayedSampleNumber() throws StdQTException
This method returns the sample number displayed currently.

QuickTime::SpriteMediaGetDisplayedSampleNumber()

Returns:
the sample number displayed currently.
 o getSpriteName
 public String getSpriteName(int spriteID) throws StdQTException
Returns the name of the sprite with the specified ID.

QuickTime::SpriteMediaGetSpriteName()

Parameters:
spriteID - Specifies the id of the sprite in question.
Returns:
the sprite name for a given sprite ID.
 o getImageName
 public String getImageName(int imageIndex) throws StdQTException
Returns the name of the sprite with the specified ID.

QuickTime::SpriteMediaGetImageName()

Parameters:
imageIndex - Specifies the index of the image whose name we wish to receive.
Returns:
the name of the image with the specified index from the current key frame sample.
 o spriteIndexToID
 public int spriteIndexToID(int spriteIndex) throws StdQTException
Return the ID of the sprite specified by spriteIndex.

QuickTime::SpriteMediaSpriteIndexToID()

Parameters:
spriteIndex - Specifies the index of the sprite for the operation.
Returns:
sprite ID of the sprite Index.
 o spriteIDtoIndex
 public short spriteIDtoIndex(int spriteID) throws StdQTException
Return the index of the sprite specified by spriteID.

QuickTime::SpriteMediaSpriteIDToIndex()

Parameters:
spriteID - Specifies the ID of the sprite for the operation.
Returns:
sprite ID of the sprite Index.
 o setActionVariable
 public void setActionVariable(int variableID,
                               float value) throws StdQTException
Sets the value of the sprite track variable with the ID of the variable to the supplied value.

QuickTime::SpriteMediaSetActionVariable()

Parameters:
variableID - Specifies a variable ID of the sprite name.
 o getActionVariable
 public float getActionVariable(int variableID) throws StdQTException
Returns the value of the sprite track variable with specified ID.

QuickTime::SpriteMediaGetActionVariable()

Parameters:
variableID - Specifies a variable ID of the sprite name.
 o getSpriteImageGroupID
 public int getSpriteImageGroupID(int imageIndex) throws StdQTException
Returns a propert value for the image specified by imageIndex.

QuickTime::SpriteMediaGetIndImageProperty()

Parameters:
imageIndex - Specifies the index of the image.
Returns:
s Sprite Image Group Property ID.
 o getSpriteImageRegistrationPoint
 public QDPoint getSpriteImageRegistrationPoint(int imageIndex) throws StdQTException
Returns a propert value for the image specified by imageIndex.

QuickTime::SpriteMediaGetIndImageProperty()

Parameters:
imageIndex - Specifies the index of the image.
Returns:
s Sprite Image Group Property ID.

All Packages  Class Hierarchy  This Package  Previous  Next  Index