Options
Menu

Interface IMyAvatar

Checked against /interface/src/avatar/MyAvatar.h 2014-09-28

Hierarchy

Index

Properties

Methods

Properties

attachmentData

attachmentData: IAttachmentData[]

audioAverageLoudness

audioAverageLoudness: number

float

audioLoudness

audioLoudness: number

float

billboardURL

billboardURL: string

bodyPitch

bodyPitch: number

float

bodyRoll

bodyRoll: number

float

bodyYaw

bodyYaw: number

float

chatMessage

chatMessage: string

collisionGroups

collisionGroups: IUInt32

collisionWithAvatar

collisionWithAvatar: ISignal

displayName

displayName: string

faceModelURL

faceModelURL: string

gravity

gravity: IVec3

handPosition

handPosition: IVec3

headOrientation

headOrientation: IQuat

headPitch

headPitch: number

float

headRoll

headRoll: number

float

headYaw

headYaw: number

float

jointNames

jointNames: Array<string>

motorReferenceFrame

motorReferenceFrame: string

motorTimescale

motorTimescale: number

float

motorVelocity

motorVelocity: IVec3

orientation

orientation: IQuat

position

position: IVec3

scale

scale: number

float

sessionUUID

sessionUUID: number

QUuid

shouldRenderLocally

shouldRenderLocally: boolean

skeletonModelURL

skeletonModelURL: string

transformChanged

transformChanged: ISignal

Methods

addThrust

  • addThrust(newThrust: IVec3)

  • Parameters

attach

  • attach(modelURL: string, jointName?: string, translation?: IVec3, rotation?: IQuat, scale?: number, allowDuplicates?: boolean, useSaved?: boolean)

  • Parameters

    • modelURL: string
    • jointName?: string optional

      default ''

    • translation?: IVec3 optional

      default { x: 0, y: 0, z: 0 }

    • rotation?: IQuat optional

      default { x: 0, y: 0, z: 0, w: 0 }

    • scale?: number optional

      default 1.0

    • allowDuplicates?: boolean optional

      default false

    • useSaved?: boolean optional

      default true

clearJointData

  • clearJointData(index: number)
  • clearJointData(name: string)

clearJointsData

  • clearJointsData()

clearReferential

  • clearReferential()

decreaseSize

  • decreaseSize()

detachAll

  • detachAll(modelURL: string, jointName?: string)

  • Parameters

    • modelURL: string
    • jointName?: string optional

      default ''

detachOne

  • detachOne(modelURL: string, jointName?: string)

  • Parameters

    • modelURL: string
    • jointName?: string optional

      default ''

getAcceleration

  • getAcceleration(): IVec3

getAngularAcceleration

  • getAngularAcceleration(): IVec3

getAngularVelocity

  • getAngularVelocity(): IVec3

getAnimationDetails

getAnimationDetailsByRole

getAttachmentData

getEyePosition

  • getEyePosition(): IVec3

  • Returns IVec3

getHandState

  • getHandState(): number

getHeadDeltaPitch

  • getHeadDeltaPitch(): number

  • Returns number

getHeadFinalPitch

  • getHeadFinalPitch(): number

  • Returns number

getHeadFinalRoll

  • getHeadFinalRoll(): number

  • Returns number

getHeadFinalYaw

  • getHeadFinalYaw(): number

  • Returns number

getHeadPosition

  • getHeadPosition(): IVec3

  • Returns IVec3

getJointCombinedRotation

  • getJointCombinedRotation(index: number): IQuat
  • getJointCombinedRotation(name: string): IQuat

getJointIndex

  • getJointIndex(name: string): number

  • Returns the index of the joint with the specified name, or -1 if not found/unknown.

    Parameters

    • name: string

    Returns number

    int

getJointNames

  • getJointNames(): Array<string>

getJointPosition

  • getJointPosition(name: string): IVec3
  • getJointPosition(index: number): IVec3

getJointRotation

  • getJointRotation(index: number): IQuat

getJointRotations

  • getJointRotations(): IQuat[]

getJointRotatoin

  • getJointRotatoin(name: string): IQuat

getLeftPalmPosition

  • getLeftPalmPosition(): IVec3

  • Returns IVec3

getRightPalmPosition

  • getRightPalmPosition(): IVec3

  • Returns IVec3

getTargetAvatarPosition

  • getTargetAvatarPosition(): IVec3

  • Returns IVec3

getThrust

  • Returns IVec3

getVelocity

goToLocation

  • goToLocation(newPosition: IVec3, hasOrientation: boolean, newOrientation: IVec3)

  • Parameters

    • newPosition: IVec3
    • hasOrientation: boolean

      default: false

    • newOrientation: IVec3

      default: { x: 0.0, y: 0.0, z: 0.0 }

hasReferential

  • hasReferential(): boolean

increaseSize

  • increaseSize()

isJointDataValid

  • isJointDataValid(index: number): boolean
  • isJointDataValid(name: string): boolean

isPaused

  • isPaused(): boolean

isPlaying

  • isPlaying(): boolean

isRecording

  • isRecording(): boolean

  • Returns boolean

loadLastRecording

  • loadLastRecording()

loadRecording

  • loadRecording(filename: string)

onToggleRagdoll

  • onToggleRagdoll()

pausePlayer

  • pausePlayer()

play

  • play()

playerCurrentFrame

  • playerCurrentFrame(): number

playerElapsed

  • playerElapsed(): number

playerFrameNumber

  • playerFrameNumber(): number

playerLength

  • playerLength(): number

recorderElapsed

  • recorderElapsed(): number

  • Returns number

    qint64

resetSize

  • resetSize()

saveRecording

  • saveRecording(filename: string)

  • Parameters

    • filename: string

sendBillboardPacket

  • sendBillboardPacket()

sendIdentityPacket

  • sendIdentityPacket()

setAttachmentData

setBillboardFromNetworkReply

  • setBillboardFromNetworkReply()

setBlendShape

  • setBlendShape(name: string, val: number)

setHandState

  • setHandState(s: number)

setJointData

  • setJointData(index: number, rotation: IQuat)
  • setJointData(name: string, rotation: IQuat)

setJointMappingsFromNetworkReply

  • setJointMappingsFromNetworkReply()

setJointModelPositionAndOrientation

  • setJointModelPositionAndOrientation(index: number, position: IVec3, rotation: IQuat)
  • setJointModelPositionAndOrientation(name: string, position: IVec3, rotation: IQuat)

setJointReferential

  • setJointReferential(id: IQUuid, jointIndex: number): boolean

  • Parameters

    • id: IQUuid
    • jointIndex: number

    Returns boolean

setJointRotations

  • setJointRotations(jointRotations: IQuat[])

setModelReferential

  • setModelReferential(id: IQUuid): boolean

  • Parameters

    Returns boolean

setPlayFromCurrentLocation

  • setPlayFromCurrentLocation(playFromCurrentLocation: boolean)

setPlayerFrame

  • setPlayerFrame(frame: number)

setPlayerLoop

  • setPlayerLoop(loop: boolean)

setPlayerTime

  • setPlayerTime(time: number)

setPlayerUseAttachments

  • setPlayerUseAttachments(useAttachments: boolean)

setPlayerUseDisplayName

  • setPlayerUseDisplayName(useDisplayName: boolean)

setPlayerUseHeadModel

  • setPlayerUseHeadModel(useHeadModel: boolean)

setSessionUUID

  • setSessionUUID(sessionUUID: number)

setThrust

  • setThrust(newThrust: IVec3)

  • Parameters

setVelocity

  • setVelocity(velocity: IVec3)

  • Parameters

startAnimation

  • startAnimation(url: string, fps?: number, priority?: number, loop?: boolean, hold?: boolean, firstFrame?: number, lastFrame?: number, maskedJoints?: Array<string>)

  • Allows scripts to run animations.

    Parameters

    • url: string
    • fps?: number optional

      default: 30.0f

    • priority?: number optional

      default: 1.0f

    • loop?: boolean optional

      default: false

    • hold?: boolean optional

      default: false

    • firstFrame?: number optional

      default: 0.0f

    • lastFrame?: number optional

      default: FLT_MAX (3.402823466e+38F)

    • maskedJoints?: Array<string> optional

      default: []

startAnimationByRole

  • startAnimationByRole(role: string, url: string, fps: number, priority: number, loop: boolean, hold: boolean, firstFrame: number, lastFrame: number, maskedJoints: Array<string>)

  • Starts an animation by its role, using the provided URL and parameters if the avatar doesn't have a custom animation for the role.

    Parameters

    • role: string
    • url: string

      default: blank

    • fps: number

      default: 30.0f

    • priority: number

      default: 1.0

    • loop: boolean

      default: false

    • hold: boolean

      default: false

    • firstFrame: number

      default: 1.0f

    • lastFrame: number

      default: FLT_MAX (3.402823466e+38F)

    • maskedJoints: Array<string>

      default: []

startPlaying

  • startPlaying()

startRecording

  • startRecording()

stopAnimation

  • stopAnimation(url: string)

  • Stops an animation as identified by a URL.

    Parameters

    • url: string

stopAnimationByRole

  • stopAnimationByRole(role: string)

  • Stops an animation identified by its role.

    Parameters

    • role: string

stopPlaying

  • stopPlaying()

stopRecording

  • stopRecording()

updateCollisionGroups

  • updateCollisionGroups()

updateMotionBehavior

  • updateMotionBehavior()

Generated using TypeDoc