The XSprite type exposes the following members.

Constructors

  NameDescription
XSprite
Creates new XSprite class instance.

Methods

  NameDescription
Add
Adds a XSprite sprite to this sprite.
AddDecorator
Adds IXSpriteDecorator decorator to the XSprite sprite.
AutoAnimate
Carries out the object animation.
Clear
Removes all sprites from the Sprites collection.
Clone
Creates an object that is a copy of this instance.
CollideWithOverloaded.
CreateObjRef

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject.)
CreateSpriteOverloaded.
DisposeOverloaded.
Equals

Determines whether the specified Object is equal to the current Object.

(Inherited from Object.)
Finalize

Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.

(Inherited from Component.)
FindDecorator
Finds the IXSpriteDecorator decorator with the name name.
FindModelSpriteOverloaded.
FindSpriteOverloaded.
ForceSetModelTransformation
Force setting of the model transform matrix.
GetAnimationIndex
Returns sprite animation number.
GetCollisionWith
Returns information about collision with another sprite.
GetHashCode

Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

(Inherited from Object.)
GetLifetimeService

Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject.)
GetLocalDirectionOverloaded.
GetLocalPositionOverloaded.
GetLocalToModelPosition
Recalculates the local coordinates to the model coordinates using the model transform.
GetModelBoundingBox
Gets the XOrientedBox oriented box for this sprite.
GetModelBoundingVolume
Gets the axially aligned sprite model XAxisAlignedBox box.
GetModelToLocalPosition
Recalculates the model coordinates to the local coordinates using the model transform.
GetModelWorldOB
Gets the XOrientedBox oriented box for this sprite in the world coordinates.
GetPositionOverloaded.
GetService

Returns an object that represents a service provided by the Component or by its Container.

(Inherited from Component.)
GetType

Gets the Type of the current instance.

(Inherited from Object.)
GetWorldDirection
Recalculates the direction vector in the local coordinates to the world coordinates.
GetWorldPosition
Recalculates the local coordinates to the world coordinates.
GetWorldRenderableTransform
Returns the world renderable IXRenderableTransform transform.
Hide
Hides the sprite.
ChangedNotify
Informs about sprite changes.
ChangedNotifyFromParent
Informs about parent sprite changes.
ChangedNotifyChildren
Informs child sprites in the Sprites collection about the parent sprite change.
CheckCollisions
Checks sprite collision with the surrounding space.
InitializeLifetimeService

Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject.)
InvalidateBoundingVolume
Invalidates the boundary volume.
InvalidateParentBoundingVolume
Invalidates the parent boundary volume.
InvalidateWorldBoundingVolume
Invalidates tne boundary volume in the world coordinates.
IsSubordinateOf
Indicates whether the sprite is contained in the sprite sprite.
LastFindModelSpriteOverloaded.
LastFindSpriteOverloaded.
MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)
ModelRayIntersect
Calculates the modelRay ray intersection with the mesh of the sprite, in local coordinates.
MoveOverloaded.
MoveLocalOverloaded.
MoveLocalInDirectionOverloaded.
NeedValidBoundingVolume
Request for the sprite boundary volume.
NeedValidLocalTransfrom
Requires valid transform matrix in the local coordinates.
NeedValidWorldBoundingVolume
Updates the sprite boundary volume in the world coordinates.
NeedValidWorldModelTransform
Requires valid model transform matrix in the world coordinates.
NeedValidWorldTransform
Requires valid transform matrix in the world coordinates.
OnAfterAnimate
Fire event AfterAnimate.
OnAnimate
Fire event Animate.
OnAutoAnimate
The method is called on object animation request.
OnBeforeAnimate
Fire event BeforeAnimate.
OnCollision
Fire event Collision.
OnDirectionChanged
Method called when the sprite orientation has changed.
OnLocalTransformationChanged
OnParentChanged
Fire event ParentChanged.
OnPutRenderable
OnSpriteInsertComplete
The method is called by the collection after finished adding of a new XSprite sprite.
OnSpriteRemoveComplete
The method is called by the collection after finished removing of a XSprite sprite.
OnSubspriteInserted
Fire event SubspriteInserted.
OnSubspriteRemoved
Fire event SubspriteRemoved.
Pitch
Sets pitch (vertical divergence) in radians.
PitchDgr
Sets pitch (vertical divergence) in degrees.
PlayAnimationOverloaded.
PointAtOverloaded.
PointAtParentLocalDirection
Turns towards the local coordinate parentDirection.
PutRenderable
RayIntersectOverloaded.
RefineCollision
Refines the information about collision with the sprite sprite2.
RemoveOverloaded.
RemoveDecorator
Removes the IXSpriteDecorator decorator from the XSprite sprite.
RescaleOverloaded.
Reset
Sets the sprite properties to default values.
ResetAnimation
Resets the sprite animation.
ResetAutoAnimationOverloaded.
ResetAutoPointing
Resets the automatic pointing.
ResetAutoRotation
Sets the sprite autorotation speed to zero.
ResetModelTransformation
Sets the model transform matrix to identity.
ResetOrientation
Sets default sprite orientation.
ResetPivotLocalPosition
Sets the sprite local pivot (center of rotation) default coordinates.
ResetPosition
Sets default sprite position.
ResetScale
Sets the sprite scale to 1.
ResetVelocity
Sets sprite velocity to zero.
Roll
Sets roll in radians.
RollDgr
Sets roll in degrees.
RotateOverloaded.
RotateDgrOverloaded.
SetAutoPointingOverloaded.
SetAutoRotationOverloaded.
SetAutoRotationAxisOverloaded.
SetAutoRotationDgrOverloaded.
SetOrientationOverloaded.
SetOrientationDgrOverloaded.
SetParent
Sets new sprite XSprite parent.
SetPivotLocalPositionOverloaded.
SetPositionOverloaded.
SetRenderDetail
Sets the mode of filling surfaces.
SetScaleOverloaded.
SetVelocityOverloaded.
SetWorldPositionOverloaded.
Show
Shows the sprite.
ToString (Inherited from Component.)
UpdateBoundingVolume
Updates the sprite boundary volume.
UpdateLocalTransform
Updates the transform matrix in the local coordinates.
UpdateWorldBoundingVolume
Request for the sprite boundary volume in the world coordinates.
UpdateWorldModelTransform
Updates the model world transform.
UpdateWorldTransform
Updates the world transform.
WorldRayIntersectOverloaded.
Yaw
Sets yaw (horizontal divergence) in radians.
YawDgr
Sets yaw (horizontal divergence) in degrees.

Fields

  NameDescription
PointAtFreeRotation
Algorithm of pointing at the sprite using the free rotation.
PointAtYawUpRotation
Algorithm of pointing at the sprite using the Y and X rotation.

Properties

  NameDescription
Animation
Gets or sets the active sprite animation number.
AnimationCount
Gets the animation count that this sprite supports.
AnimationNames
Gets all animation names that this sprite supports.
Animations
Gets all animations that this sprite supports in the form of a AnimationSet collection.
AnimationSpeed
Gets or sets the animation speed.
AnimationTime
Gets or sets the animation duration time.
Attributes
Gets the sprite Hashtable attributes table.
AutoAnimation
Enables or disables the automatic animation.
AutoAnimationPaused
Gets or sets whether the automatic animation is paused (disabled, no animation evens are being sent).
AutoPointing
Enables or disables the automatic pointing.
AutoPointingOffset
Gets or sets the offset in tle local coordinates of the sprite pointed at.
AutoPointingTarget
Gets or sets the sprite that this sprite will be pointing at.
AutoRotation
Gets the sprite autorotation in the form of Quaternion.
AutoRotationAngle
Gets or sets the rotation angle in the autorotation, in radians.
AutoRotationAngleDgr
Gets or sets the rotation angle in the autorotation, in degrees.
AutoRotationAxis
Gets or sets the sprite autorotation axis.
AutoRotationPaused
Gets or sets whether the autorotation is paused.
AutoRotationSpeed
Gets or sets the autorotation speed in radians per second.
AutoRotationSpeedDgr
Gets or sets the autorotation speed in degrees per second.
BoundingVolume
Gets the sprite XAxisAlignedBox boundary volume.
BoundingVolumeLineBox
Gets the XBoundingVolumeLineBoxSpriteDecorator decorator that bounds the sprite with wire box, showing the sprite's boundary volume.
CollisionDetection
Gets or sets the XCollisionDetection collision detection of this sprite with another sprites.
Color
Gets or sets the color of the single-color material.
Container

Gets the IContainer that contains the Component.

(Inherited from Component.)
DesignMode

Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component.)
DirectionOrientation
Gets the Quaternion orientation direction.
Events

Gets the list of event handlers that are attached to this Component.

(Inherited from Component.)
ForwardDirection
Gets or sets the forward direction.
HasMaterial
Returns trueTruetruetrue (True in Visual Basic) if the sprite contains a material, otherwise falseFalsefalsefalse (False in Visual Basic).
HasParent
Returns trueTruetruetrue (True in Visual Basic) if the sprite has parent.
Id
Gets unique sprite identifier.
IsRoot
Returns trueTruetruetrue (True in Visual Basic) if the sprite is the root sprite.
IsScaled
Returns trueTruetruetrue (True in Visual Basic) if the sprite is scaled.
IsWorldRoot
Returns trueTruetruetrue (True in Visual Basic) if the sprite is the world root sprite.
Item
Gets the XSprite sprite in the sprite collection that this instance contains.
LengthUnit
Gets the unit distance in this world.
LocalTransformation
Gets sprite transform matrix in the local coordinates.
Material
Gets or sets the XMaterial material for this sprite.
ModelBoundingVolume
Gets the model XAxisAlignedBox boundary volume.
ModelTransformation
Gets or sets the model transforming matrix.
ModelTransformationUsed
Returns trueTruetruetrue (True in Visual Basic) if the model transforming matrix is used.
ModelWorldBoundingVolume
Gets the model XAxisAlignedBox boundary volume in the world coordinates.
ModelWorldTransformation
Gets the world model transforming matrix.
Name
Gets or sets the sprite name.
Orientation
Gets or sets an orientation Quaternion.
OrientationDgr
Gets or sets an orientation of the sprite in degrees.
Parent
Gets or sets the sprite parent.
PivotLocalPosition
Gets or sets the sprite local pivot (center of rotation) coordinates.
PivotLocalPositionX
Gets or sets the sprite local pivot (center of rotation) X coordinate.
PivotLocalPositionY
Gets or sets the sprite local pivot (center of rotation) Y coordinate.
PivotLocalPositionZ
Gets or sets the sprite local pivot (center of rotation) Z coordinate.
PointAtAlgorithm
Gets or sets the sprite point at algorithm. XSprite..::.PointAtFreeRotationXSprite..::.PointAtYawUpRotationvalue is nullNothingnullptra null reference (Nothing in Visual Basic).
Position
Gets or sets a position of the sprite.
RenderDetail
Gets or sets the mode of filling surfaces.
Root
Gets the root XSprite sprite of this instance. Root sprite is sprite that does not have parent sprite.
Scale
Gets or sets the sprite scale.
ScaleXYZ
Gets or sets the sprite homogeneous scale.
Site

Gets or sets the ISite of the Component.

(Inherited from Component.)
Sprites
Gets the collection of XSprite sprites that this sprite instance contains.
SyncRoot
Returns the object that can be used for synchronizing access to this instance.
Text
Gets or sets the name of the sprite.
Timer
Gets the XTimer class instance for working with time in this world.
UpwardDirection
Gets or sets the upward direction.
Velocity
Gets or sets the sprite velocity.
VelocityX
Gets or sets the sprite velocity in the direction of X.
VelocityY
Gets or sets the sprite velocity in the direction of Y.
VelocityZ
Gets or sets the sprite velocity in the direction of Z.
Visible
Gets or sets the sprite visibility.
World
Returns the XWorld world that contains the sprite.
WorldBoundingVolume
Gets the sprite XAxisAlignedBox boundary volume in the world coordinates.
WorldOrientation
Gets the sprite orientation in the world coordinates.
WorldPosition
Gets coordinates in the XWorld world. In opposite to the Position, this property does not reffer to the relative position in parent, but to the world coordinates.
WorldTransformation
Gets sprite transform matrix in the world coordinates.
WorldVisible
Returns trueTruetruetrue (True in Visual Basic) if the sprite is visible in the XWorld world. The difference from Visible is that this tests the parent visibility.
X
Gets or sets the X coordinate of the sprite.
Y
Gets or sets the Y coordinate of the sprite.
Z
Gets or sets the Z coordinate of the sprite.

Events

  NameDescription
AfterAnimate
The event is fired after carrying out the sprite animation.
Animate
The event is fired when the sprite is animated.
BeforeAnimate
The event is fired before carrying out the sprite animation.
Collision
Event is fired if the sprites collides with another one.
Disposed

Adds an event handler to listen to the Disposed event on the component.

(Inherited from Component.)
LocalTransformationChanged
The event is fired when sprite transform matrix is changed.
ParentChanged
Event that tracks sprite parent change.
SubspriteInserted
Event that tracks adding of a sprite to the Sprites sprite collection.
SubspriteRemoved
Event that tracks removing of a sprite from the Sprites sprite collection.

See Also