ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes

Language Reference only
Filters: AIR 32.0 and earlier, Flash Player 32.0 and earlier, Flash Lite 4
Flex 4.6 and earlier, Flash Pro CS6 and earlier
Hide Filters
fl.ik 

IKJoint  - AS3 Flash

Packagesx

Top Level
adobe.utils
air.desktop
air.net
air.update
air.update.events
coldfusion.air
coldfusion.air.errors
coldfusion.air.events
coldfusion.service
coldfusion.service.events
coldfusion.service.mxml
com.adobe.acm.solutions.authoring.domain.extensions
com.adobe.acm.solutions.ccr.domain.extensions
com.adobe.consulting.pst.vo
com.adobe.dct.component
com.adobe.dct.component.datadictionary
com.adobe.dct.component.datadictionaryElement
com.adobe.dct.component.dataElementsPanel
com.adobe.dct.component.toolbars
com.adobe.dct.event
com.adobe.dct.exp
com.adobe.dct.model
com.adobe.dct.service
com.adobe.dct.service.provider
com.adobe.dct.transfer
com.adobe.dct.util
com.adobe.dct.view
com.adobe.ep.taskmanagement.domain
com.adobe.ep.taskmanagement.event
com.adobe.ep.taskmanagement.filter
com.adobe.ep.taskmanagement.services
com.adobe.ep.taskmanagement.util
com.adobe.ep.ux.attachmentlist.component
com.adobe.ep.ux.attachmentlist.domain
com.adobe.ep.ux.attachmentlist.domain.events
com.adobe.ep.ux.attachmentlist.domain.renderers
com.adobe.ep.ux.attachmentlist.skin
com.adobe.ep.ux.attachmentlist.skin.renderers
com.adobe.ep.ux.content.event
com.adobe.ep.ux.content.factory
com.adobe.ep.ux.content.handlers
com.adobe.ep.ux.content.managers
com.adobe.ep.ux.content.model.asset
com.adobe.ep.ux.content.model.preview
com.adobe.ep.ux.content.model.relation
com.adobe.ep.ux.content.model.search
com.adobe.ep.ux.content.model.toolbar
com.adobe.ep.ux.content.search
com.adobe.ep.ux.content.services
com.adobe.ep.ux.content.services.load
com.adobe.ep.ux.content.services.permissions
com.adobe.ep.ux.content.services.preview
com.adobe.ep.ux.content.services.providers
com.adobe.ep.ux.content.services.query
com.adobe.ep.ux.content.services.relationships
com.adobe.ep.ux.content.services.search.lccontent
com.adobe.ep.ux.content.services.version
com.adobe.ep.ux.content.view
com.adobe.ep.ux.content.view.components.activate
com.adobe.ep.ux.content.view.components.grid
com.adobe.ep.ux.content.view.components.grid.hover
com.adobe.ep.ux.content.view.components.grid.hover.component
com.adobe.ep.ux.content.view.components.grid.renderers
com.adobe.ep.ux.content.view.components.relationships
com.adobe.ep.ux.content.view.components.review
com.adobe.ep.ux.content.view.components.search.renderers
com.adobe.ep.ux.content.view.components.searchpod
com.adobe.ep.ux.content.view.components.toolbar
com.adobe.ep.ux.content.view.components.toolbar.controlRenderers
com.adobe.ep.ux.content.view.components.version
com.adobe.ep.ux.documentsubmit.component
com.adobe.ep.ux.documentsubmit.domain
com.adobe.ep.ux.documentsubmit.skin
com.adobe.ep.ux.taskaction.component
com.adobe.ep.ux.taskaction.domain
com.adobe.ep.ux.taskaction.domain.events
com.adobe.ep.ux.taskaction.skin
com.adobe.ep.ux.taskdetails.component
com.adobe.ep.ux.taskdetails.domain
com.adobe.ep.ux.taskdetails.skin
com.adobe.ep.ux.tasklist.component
com.adobe.ep.ux.tasklist.domain
com.adobe.ep.ux.tasklist.skin
com.adobe.ep.ux.webdocumentviewer.domain
com.adobe.exm.expression
com.adobe.exm.expression.error
com.adobe.exm.expression.event
com.adobe.exm.expression.impl
com.adobe.fiber.runtime.lib
com.adobe.fiber.services
com.adobe.fiber.services.wrapper
com.adobe.fiber.styles
com.adobe.fiber.util
com.adobe.fiber.valueobjects
com.adobe.gravity.binding
com.adobe.gravity.context
com.adobe.gravity.flex.bundleloader
com.adobe.gravity.flex.progress
com.adobe.gravity.flex.serviceloader
com.adobe.gravity.framework
com.adobe.gravity.init
com.adobe.gravity.service.bundleloader
com.adobe.gravity.service.logging
com.adobe.gravity.service.manifest
com.adobe.gravity.service.progress
com.adobe.gravity.tracker
com.adobe.gravity.ui
com.adobe.gravity.utility
com.adobe.gravity.utility.async
com.adobe.gravity.utility.error
com.adobe.gravity.utility.events
com.adobe.gravity.utility.factory
com.adobe.gravity.utility.flex.async
com.adobe.gravity.utility.logging
com.adobe.gravity.utility.message
com.adobe.gravity.utility.sequence
com.adobe.gravity.utility.url
com.adobe.guides.control
com.adobe.guides.domain
com.adobe.guides.i18n
com.adobe.guides.spark.components.skins
com.adobe.guides.spark.components.skins.mx
com.adobe.guides.spark.headers.components
com.adobe.guides.spark.headers.skins
com.adobe.guides.spark.layouts.components
com.adobe.guides.spark.layouts.skins
com.adobe.guides.spark.navigators.components
com.adobe.guides.spark.navigators.renderers
com.adobe.guides.spark.navigators.skins
com.adobe.guides.spark.util
com.adobe.guides.spark.wrappers.components
com.adobe.guides.spark.wrappers.skins
com.adobe.guides.submit
com.adobe.icc.dc.domain
com.adobe.icc.dc.domain.factory
com.adobe.icc.editors.events
com.adobe.icc.editors.handlers
com.adobe.icc.editors.managers
com.adobe.icc.editors.model
com.adobe.icc.editors.model.config
com.adobe.icc.editors.model.el
com.adobe.icc.editors.model.el.operands
com.adobe.icc.editors.model.el.operators
com.adobe.icc.enum
com.adobe.icc.external.dc
com.adobe.icc.obj
com.adobe.icc.services
com.adobe.icc.services.category
com.adobe.icc.services.config
com.adobe.icc.services.download
com.adobe.icc.services.export
com.adobe.icc.services.external
com.adobe.icc.services.formbridge
com.adobe.icc.services.fragmentlayout
com.adobe.icc.services.layout
com.adobe.icc.services.letter
com.adobe.icc.services.locator
com.adobe.icc.services.module
com.adobe.icc.services.render
com.adobe.icc.services.submit
com.adobe.icc.services.user
com.adobe.icc.token
com.adobe.icc.vo
com.adobe.icc.vo.render
com.adobe.icomm.assetplacement.controller
com.adobe.icomm.assetplacement.controller.utils
com.adobe.icomm.assetplacement.data
com.adobe.icomm.assetplacement.model
com.adobe.livecycle.assetmanager.client
com.adobe.livecycle.assetmanager.client.event
com.adobe.livecycle.assetmanager.client.handler
com.adobe.livecycle.assetmanager.client.managers
com.adobe.livecycle.assetmanager.client.model
com.adobe.livecycle.assetmanager.client.model.cms
com.adobe.livecycle.assetmanager.client.service
com.adobe.livecycle.assetmanager.client.service.search
com.adobe.livecycle.assetmanager.client.service.search.cms
com.adobe.livecycle.assetmanager.client.utils
com.adobe.livecycle.content
com.adobe.livecycle.rca.model
com.adobe.livecycle.rca.model.constant
com.adobe.livecycle.rca.model.document
com.adobe.livecycle.rca.model.participant
com.adobe.livecycle.rca.model.reminder
com.adobe.livecycle.rca.model.stage
com.adobe.livecycle.rca.service
com.adobe.livecycle.rca.service.core
com.adobe.livecycle.rca.service.core.delegate
com.adobe.livecycle.rca.service.process
com.adobe.livecycle.rca.service.process.delegate
com.adobe.livecycle.rca.token
com.adobe.livecycle.ria.security.api
com.adobe.livecycle.ria.security.service
com.adobe.mosaic.layouts
com.adobe.mosaic.layouts.dragAndDrop
com.adobe.mosaic.layouts.interfaces
com.adobe.mosaic.mxml
com.adobe.mosaic.om.constants
com.adobe.mosaic.om.events
com.adobe.mosaic.om.impl
com.adobe.mosaic.om.interfaces
com.adobe.mosaic.skinning
com.adobe.mosaic.sparklib.editors
com.adobe.mosaic.sparklib.optionMenu
com.adobe.mosaic.sparklib.scrollableMenu
com.adobe.mosaic.sparklib.scrollableMenu.skins
com.adobe.mosaic.sparklib.tabLayout
com.adobe.mosaic.sparklib.tabLayout.events
com.adobe.mosaic.sparklib.tabLayout.layouts
com.adobe.mosaic.sparklib.tabLayout.skins
com.adobe.mosaic.sparklib.text
com.adobe.mosaic.sparklib.util
com.adobe.solutions.acm.authoring.presentation
com.adobe.solutions.acm.authoring.presentation.actionbar
com.adobe.solutions.acm.authoring.presentation.common
com.adobe.solutions.acm.authoring.presentation.events
com.adobe.solutions.acm.authoring.presentation.fragment
com.adobe.solutions.acm.authoring.presentation.letter
com.adobe.solutions.acm.authoring.presentation.letter.data
com.adobe.solutions.acm.authoring.presentation.preview
com.adobe.solutions.acm.authoring.presentation.rte
com.adobe.solutions.acm.ccr.presentation
com.adobe.solutions.acm.ccr.presentation.contentcapture
com.adobe.solutions.acm.ccr.presentation.contentcapture.events
com.adobe.solutions.acm.ccr.presentation.contentcapture.preview
com.adobe.solutions.acm.ccr.presentation.datacapture
com.adobe.solutions.acm.ccr.presentation.datacapture.renderers
com.adobe.solutions.acm.ccr.presentation.pdf
com.adobe.solutions.exm
com.adobe.solutions.exm.authoring
com.adobe.solutions.exm.authoring.components.controls
com.adobe.solutions.exm.authoring.components.toolbars
com.adobe.solutions.exm.authoring.domain
com.adobe.solutions.exm.authoring.domain.expression
com.adobe.solutions.exm.authoring.domain.impl
com.adobe.solutions.exm.authoring.domain.method
com.adobe.solutions.exm.authoring.domain.variable
com.adobe.solutions.exm.authoring.enum
com.adobe.solutions.exm.authoring.events
com.adobe.solutions.exm.authoring.model
com.adobe.solutions.exm.authoring.renderer
com.adobe.solutions.exm.authoring.view
com.adobe.solutions.exm.expression
com.adobe.solutions.exm.impl
com.adobe.solutions.exm.impl.method
com.adobe.solutions.exm.method
com.adobe.solutions.exm.mock
com.adobe.solutions.exm.mock.method
com.adobe.solutions.exm.runtime
com.adobe.solutions.exm.runtime.impl
com.adobe.solutions.exm.variable
com.adobe.solutions.prm.constant
com.adobe.solutions.prm.domain
com.adobe.solutions.prm.domain.factory
com.adobe.solutions.prm.domain.impl
com.adobe.solutions.prm.domain.manager
com.adobe.solutions.prm.presentation.asset
com.adobe.solutions.prm.presentation.constant
com.adobe.solutions.prm.presentation.document
com.adobe.solutions.prm.presentation.event
com.adobe.solutions.prm.presentation.file
com.adobe.solutions.prm.presentation.project
com.adobe.solutions.prm.presentation.team
com.adobe.solutions.prm.presentation.util
com.adobe.solutions.prm.service
com.adobe.solutions.prm.services.impl
com.adobe.solutions.prm.vo
com.adobe.solutions.rca.constant
com.adobe.solutions.rca.domain
com.adobe.solutions.rca.domain.common
com.adobe.solutions.rca.domain.factory
com.adobe.solutions.rca.domain.impl
com.adobe.solutions.rca.domain.impl.manager
com.adobe.solutions.rca.domain.manager
com.adobe.solutions.rca.presentation
com.adobe.solutions.rca.presentation.comment
com.adobe.solutions.rca.presentation.constant
com.adobe.solutions.rca.presentation.event
com.adobe.solutions.rca.presentation.gantt
com.adobe.solutions.rca.presentation.gantt.ruler
com.adobe.solutions.rca.presentation.template
com.adobe.solutions.rca.presentation.template.audit
com.adobe.solutions.rca.presentation.template.definition
com.adobe.solutions.rca.presentation.template.documents
com.adobe.solutions.rca.presentation.template.stages
com.adobe.solutions.rca.presentation.util
com.adobe.solutions.rca.service
com.adobe.solutions.rca.services.impl
com.adobe.solutions.rca.vo
com.adobe.solutions.rca.vo.um
com.adobe.viewsource
fl.accessibility
fl.containers
fl.controls
fl.controls.dataGridClasses
fl.controls.listClasses
fl.controls.progressBarClasses
fl.core
fl.data
fl.display
fl.events
fl.ik
fl.lang
fl.livepreview
fl.managers
fl.motion
fl.motion.easing
fl.rsl
fl.text
fl.transitions
fl.transitions.easing
fl.video
flash.accessibility
flash.concurrent
flash.crypto
flash.data
flash.desktop
flash.display
flash.display3D
flash.display3D.textures
flash.errors
flash.events
flash.external
flash.filesystem
flash.filters
flash.geom
flash.globalization
flash.html
flash.media
flash.net
flash.net.dns
flash.net.drm
flash.notifications
flash.permissions
flash.printing
flash.profiler
flash.sampler
flash.security
flash.sensors
flash.system
flash.text
flash.text.engine
flash.text.ime
flash.ui
flash.utils
flash.xml
flashx.textLayout
flashx.textLayout.compose
flashx.textLayout.container
flashx.textLayout.conversion
flashx.textLayout.edit
flashx.textLayout.elements
flashx.textLayout.events
flashx.textLayout.factory
flashx.textLayout.formats
flashx.textLayout.operations
flashx.textLayout.utils
flashx.undo
ga.controls
ga.layouts
ga.model
ga.uiComponents
ga.util
ga.views
ga.wrappers
lc.foundation
lc.foundation.domain
lc.foundation.events
lc.foundation.ui
lc.foundation.util
lc.preloader
lc.procmgmt
lc.procmgmt.commands
lc.procmgmt.domain
lc.procmgmt.events
lc.procmgmt.formbridge
lc.procmgmt.impl
lc.procmgmt.ui.attachments
lc.procmgmt.ui.controls
lc.procmgmt.ui.controls.card
lc.procmgmt.ui.controls.renderer
lc.procmgmt.ui.help
lc.procmgmt.ui.layout
lc.procmgmt.ui.presentationmodel
lc.procmgmt.ui.process
lc.procmgmt.ui.search
lc.procmgmt.ui.startpoint
lc.procmgmt.ui.task
lc.procmgmt.ui.task.form
lc.procmgmt.ui.task.form.commands
lc.procmgmt.ui.tracking
mx.accessibility
mx.automation
mx.automation.air
mx.automation.delegates
mx.automation.delegates.advancedDataGrid
mx.automation.delegates.charts
mx.automation.delegates.containers
mx.automation.delegates.controls
mx.automation.delegates.controls.dataGridClasses
mx.automation.delegates.controls.fileSystemClasses
mx.automation.delegates.core
mx.automation.delegates.flashflexkit
mx.automation.events
mx.binding
mx.binding.utils
mx.charts
mx.charts.chartClasses
mx.charts.effects
mx.charts.effects.effectClasses
mx.charts.events
mx.charts.renderers
mx.charts.series
mx.charts.series.items
mx.charts.series.renderData
mx.charts.styles
mx.collections
mx.collections.errors
mx.containers
mx.containers.accordionClasses
mx.containers.dividedBoxClasses
mx.containers.errors
mx.containers.utilityClasses
mx.controls
mx.controls.advancedDataGridClasses
mx.controls.dataGridClasses
mx.controls.listClasses
mx.controls.menuClasses
mx.controls.olapDataGridClasses
mx.controls.scrollClasses
mx.controls.sliderClasses
mx.controls.textClasses
mx.controls.treeClasses
mx.controls.videoClasses
mx.core
mx.core.windowClasses
mx.data
mx.data.crypto
mx.data.errors
mx.data.events
mx.data.messages
mx.data.mxml
mx.data.offline.errors
mx.data.utils
mx.effects
mx.effects.easing
mx.effects.effectClasses
mx.events
mx.filters
mx.flash
mx.formatters
mx.geom
mx.graphics
mx.graphics.codec
mx.graphics.shaderClasses
mx.logging
mx.logging.errors
mx.logging.targets
mx.managers
mx.messaging
mx.messaging.channels
mx.messaging.config
mx.messaging.errors
mx.messaging.events
mx.messaging.management
mx.messaging.messages
mx.modules
mx.netmon
mx.olap
mx.olap.aggregators
mx.preloaders
mx.printing
mx.resources
mx.rpc
mx.rpc.events
mx.rpc.http
mx.rpc.http.mxml
mx.rpc.livecycle
mx.rpc.mxml
mx.rpc.remoting
mx.rpc.remoting.mxml
mx.rpc.soap
mx.rpc.soap.mxml
mx.rpc.wsdl
mx.rpc.xml
mx.skins
mx.skins.halo
mx.skins.spark
mx.skins.wireframe
mx.skins.wireframe.windowChrome
mx.states
mx.styles
mx.utils
mx.validators
org.osmf.containers
org.osmf.display
org.osmf.elements
org.osmf.events
org.osmf.layout
org.osmf.logging
org.osmf.media
org.osmf.metadata
org.osmf.net
org.osmf.net.dvr
org.osmf.net.httpstreaming
org.osmf.net.metrics
org.osmf.net.qos
org.osmf.net.rtmpstreaming
org.osmf.net.rules
org.osmf.traits
org.osmf.utils
spark.accessibility
spark.automation.delegates
spark.automation.delegates.components
spark.automation.delegates.components.gridClasses
spark.automation.delegates.components.mediaClasses
spark.automation.delegates.components.supportClasses
spark.automation.delegates.skins.spark
spark.automation.events
spark.collections
spark.components
spark.components.calendarClasses
spark.components.gridClasses
spark.components.mediaClasses
spark.components.supportClasses
spark.components.windowClasses
spark.core
spark.effects
spark.effects.animation
spark.effects.easing
spark.effects.interpolation
spark.effects.supportClasses
spark.events
spark.filters
spark.formatters
spark.formatters.supportClasses
spark.globalization
spark.globalization.supportClasses
spark.layouts
spark.layouts.supportClasses
spark.managers
spark.modules
spark.preloaders
spark.primitives
spark.primitives.supportClasses
spark.skins
spark.skins.mobile
spark.skins.mobile.supportClasses
spark.skins.spark
spark.skins.spark.mediaClasses.fullScreen
spark.skins.spark.mediaClasses.normal
spark.skins.spark.windowChrome
spark.skins.wireframe
spark.skins.wireframe.mediaClasses
spark.skins.wireframe.mediaClasses.fullScreen
spark.transitions
spark.utils
spark.validators
spark.validators.supportClasses
xd.core.axm.enterprise.view.components
xd.core.axm.enterprise.view.skins
xd.core.axm.view.components
xd.core.axm.view.components.support

Language Elements

Global Constants
Global Functions
Operators
Statements, Keywords & Directives
Special Types

Appendixes

What's New
Compiler Errors
Compiler Warnings
Run-Time Errors
Migrating to ActionScript 3
Supported Character Sets
MXML Only Tags
Motion XML Elements
Timed Text Tags
List of deprecated elements
Accessibility Implementation Constants
How to Use ActionScript Examples
Legal notices
Packagefl.ik
Classpublic class IKJoint
InheritanceIKJoint Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The IKJoint class defines a connection between two bones, which are required foundational components of an inverse kinematics (IK) armature. IKJoint objects are called "joints" and the IKJoint class defines properties and constraints for how bones connect and move in relation to one another.

More examples

Related API Elements



Public Properties
 PropertyDefined By
  bone : IKBone
[read-only] The head bone associated with the IKJoint object.
IKJoint
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  DOF_ROTATION : int = 1
[static] Static constant for the rotation degree of freedom.
IKJoint
  DOF_XTRANS : int = 2
[static] Static constant for the x-translation degree of freedom.
IKJoint
  DOF_YTRANS : int = 4
[static] Static constant for the y-translation degree of freedom.
IKJoint
  name : String
The IKJoint instance's name.
IKJoint
  numChildren : int
[read-only] Returns the number of IKJoint objects branching from the specified IKJoint.
IKJoint
  parent : IKJoint
The parent IKJoint object.
IKJoint
  position : Point
[read-only] The IKJoint's coordinates.
IKJoint
  rotation : Number
[read-only] The current rotation value.
IKJoint
  rotationConstrained : Boolean
Returns if the rotation is constrained.
IKJoint
  rotationEnabled : Boolean
Specifies if the rotation is enabled.
IKJoint
  rotationMax : Number
The maximum rotation value.
IKJoint
  rotationMin : Number
The minimum rotation value.
IKJoint
  speed : Number
The rotation speed degree of freedom; the xTranslation and yTranslation properties respect the same speed setting.
IKJoint
  springDamping : Number
The spring damping value.
IKJoint
  springPosition : Number
The spring position (for translational joints) or angle (for rotational joints).
IKJoint
  springStrength : Number
The spring strength value.
IKJoint
  xTranslation : Number
[read-only] The current x-translation value.
IKJoint
  xTranslationConstrained : Boolean
Returns if the x-translation is constrained.
IKJoint
  xTranslationEnabled : Boolean
Specifies if the x-translation is enabled.
IKJoint
  xTranslationMax : Number
The maximum x-translation value.
IKJoint
  xTranslationMin : Number
The minimum x-translation value.
IKJoint
  yTranslation : Number
[read-only] The current y-translation value.
IKJoint
  yTranslationConstrained : Boolean
Returns if the y-translation is constrained.
IKJoint
  yTranslationEnabled : Boolean
Specifies if the y-translation is enabled.
IKJoint
  yTranslationMax : Number
The maximum y-translation value.
IKJoint
  yTranslationMin : Number
The minimum y-translation value.
IKJoint
Public Methods
 MethodDefined By
  
Clears the current spring angle.
IKJoint
  
Clears the current spring point.
IKJoint
  
Returns the child IKJoint object at the specified index value.
IKJoint
  
Returns the index value of the specified IKJoint object.
IKJoint
  
Retrieves the current value of the specified type of degree of freedom.
IKJoint
  
Returns the current spring angle.
IKJoint
  
Returns the current spring point.
IKJoint
 Inherited
Indicates whether an object has a specified property defined.
Object
  
hasPhysics(recursive:Boolean = true):Boolean
Returns whether the sub-tree (children) of the joint has physics applied.
IKJoint
  
Returns whether the current spring angle is set.
IKJoint
  
Returns whether a spring point is currently set.
IKJoint
  
Returns if the type of degree of freedom is constrained.
IKJoint
  
Returns if the specified type of degree of freedom is enabled.
IKJoint
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
setConstrained(dof:int, constrained:Boolean):void
Sets the constraint of the specified type of degree of freedom.
IKJoint
  
setEnabled(dof:int, enable:Boolean):*
Enables or disables the specified type of degree of freedom.
IKJoint
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
Sets the current spring angle.
IKJoint
  
Sets the current spring point.
IKJoint
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

bone

property
bone:IKBone  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The head bone associated with the IKJoint object.



Implementation
    public function get bone():IKBone

DOF_ROTATION

property 
public static var DOF_ROTATION:int = 1

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Static constant for the rotation degree of freedom.

DOF_XTRANS

property 
public static var DOF_XTRANS:int = 2

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Static constant for the x-translation degree of freedom.

DOF_YTRANS

property 
public static var DOF_YTRANS:int = 4

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Static constant for the y-translation degree of freedom.

name

property 
name:String

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The IKJoint instance's name.



Implementation
    public function get name():String
    public function set name(value:String):void

numChildren

property 
numChildren:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the number of IKJoint objects branching from the specified IKJoint. This method does not account for sub-branches. Traverse each child branch to traverse the whole IKArmature object.



Implementation
    public function get numChildren():int

parent

property 
parent:IKJoint

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The parent IKJoint object.



Implementation
    public function get parent():IKJoint
    public function set parent(value:IKJoint):void

position

property 
position:Point  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The IKJoint's coordinates.



Implementation
    public function get position():Point

rotation

property 
rotation:Number  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The current rotation value. This value is read-only. The IKMover object udpates this value automatically during an IK movement.



Implementation
    public function get rotation():Number

rotationConstrained

property 
rotationConstrained:Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Returns if the rotation is constrained.



Implementation
    public function get rotationConstrained():Boolean
    public function set rotationConstrained(value:Boolean):void

rotationEnabled

property 
rotationEnabled:Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Specifies if the rotation is enabled.



Implementation
    public function get rotationEnabled():Boolean
    public function set rotationEnabled(value:Boolean):void

rotationMax

property 
rotationMax:Number

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The maximum rotation value.



Implementation
    public function get rotationMax():Number
    public function set rotationMax(value:Number):void

rotationMin

property 
rotationMin:Number

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The minimum rotation value.



Implementation
    public function get rotationMin():Number
    public function set rotationMin(value:Number):void

speed

property 
speed:Number

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The rotation speed degree of freedom; the xTranslation and yTranslation properties respect the same speed setting.



Implementation
    public function get speed():Number
    public function set speed(value:Number):void

springDamping

property 
springDamping:Number

Language Version: ActionScript 3.0
Product Version: Flash CS5
Runtime Versions: Flash Player 10, AIR 1.5

The spring damping value. Damping adds spring resistance when used in conjunction with the strength property. It affects the rate of decay for the spring, which is the amount of time between the initial movement and when the bones connected to the joint return to their rest position. The range is from 0 (no resistance, the default) to 100 (highly damped). A maximum damping value does not negate strength With damping at 100 and strength at 1, there is still an effect. Because of the rigidity of the joint, it may be difficult to notice, but there is a physics-based reaction nonetheless.



Implementation
    public function get springDamping():Number
    public function set springDamping(value:Number):void

Example  ( How to use this example )
The following example applies randomly generated IKJoint.springStrength and IKJoint.springDamping values for each joint of the first armature on the stage. This example comes from Mike Welsh.
import fl.ik.*;

var armature:IKArmature = IKManager.getArmatureAt(0);
armature.springsEnabled = true;
var joint:IKJoint = armature.rootJoint;
while(joint)
{
    joint.springStrength = Math.random() * 10;
    joint.springDamping = Math.random() * 100;
    
    if(joint.numChildren > 0)joint = joint.getChildAt(0);
    else joint = null;
}

springPosition

property 
springPosition:Number

Language Version: ActionScript 3.0
Product Version: Flash CS5
Runtime Versions: Flash Player 10, AIR 1.5

The spring position (for translational joints) or angle (for rotational joints).



Implementation
    public function get springPosition():Number
    public function set springPosition(value:Number):void

springStrength

property 
springStrength:Number

Language Version: ActionScript 3.0
Product Version: Flash CS5
Runtime Versions: Flash Player 10, AIR 1.5

The spring strength value. This is the amount of spring in the joint. The range is from 1-100, with 0 being rigid (the default Flash behavior) and 100 being a very loose spring that is mostly controlled by physics.



Implementation
    public function get springStrength():Number
    public function set springStrength(value:Number):void

Example  ( How to use this example )
The following example applies randomly generated IKJoint.springStrength and IKJoint.springDamping values for each joint of the first armature on the stage. This example comes from Mike Welsh.
import fl.ik.*;

var armature:IKArmature = IKManager.getArmatureAt(0);
armature.springsEnabled = true;
var joint:IKJoint = armature.rootJoint;
while(joint)
{
    joint.springStrength = Math.random() * 10;
    joint.springDamping = Math.random() * 100;
    
    if(joint.numChildren > 0)joint = joint.getChildAt(0);
    else joint = null;
}

xTranslation

property 
xTranslation:Number  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The current x-translation value. This value is read-only. The IKMover object udpates this value automatically during an IK movement.



Implementation
    public function get xTranslation():Number

xTranslationConstrained

property 
xTranslationConstrained:Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Returns if the x-translation is constrained.



Implementation
    public function get xTranslationConstrained():Boolean
    public function set xTranslationConstrained(value:Boolean):void

xTranslationEnabled

property 
xTranslationEnabled:Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Specifies if the x-translation is enabled.



Implementation
    public function get xTranslationEnabled():Boolean
    public function set xTranslationEnabled(value:Boolean):void

xTranslationMax

property 
xTranslationMax:Number

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The maximum x-translation value.



Implementation
    public function get xTranslationMax():Number
    public function set xTranslationMax(value:Number):void

xTranslationMin

property 
xTranslationMin:Number

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The minimum x-translation value.



Implementation
    public function get xTranslationMin():Number
    public function set xTranslationMin(value:Number):void

yTranslation

property 
yTranslation:Number  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The current y-translation value. This value is read-only. The IKMover object udpates this value automatically during an IK movement.



Implementation
    public function get yTranslation():Number

yTranslationConstrained

property 
yTranslationConstrained:Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Returns if the y-translation is constrained.



Implementation
    public function get yTranslationConstrained():Boolean
    public function set yTranslationConstrained(value:Boolean):void

yTranslationEnabled

property 
yTranslationEnabled:Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Specifies if the y-translation is enabled.



Implementation
    public function get yTranslationEnabled():Boolean
    public function set yTranslationEnabled(value:Boolean):void

yTranslationMax

property 
yTranslationMax:Number

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The maximum y-translation value.



Implementation
    public function get yTranslationMax():Number
    public function set yTranslationMax(value:Number):void

yTranslationMin

property 
yTranslationMin:Number

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

The minimum y-translation value.



Implementation
    public function get yTranslationMin():Number
    public function set yTranslationMin(value:Number):void
Method Detail

clearSpringAngle

()method
public function clearSpringAngle():void

Language Version: ActionScript 3.0
Product Version: Flash CS5
Runtime Versions: Flash Player 10, AIR 1.5

Clears the current spring angle.

clearSpringPoint

()method 
public function clearSpringPoint():void

Language Version: ActionScript 3.0
Product Version: Flash CS5
Runtime Versions: Flash Player 10, AIR 1.5

Clears the current spring point.

getChildAt

()method 
public function getChildAt(iChild:int):IKJoint

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the child IKJoint object at the specified index value.

Parameters

iChild:int — The zero-based index number of the joint to retrieve.

Returns
IKJoint — Returns the IKJoint instance at the specified index value.

getChildIndex

()method 
public function getChildIndex(child:IKJoint):int

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Returns the index value of the specified IKJoint object.

Parameters

child:IKJoint — The targeted child joint.

Returns
int — Returns the zero-based index value of the specified IKJoint object.

getJointValue

()method 
public function getJointValue(dof:int):Number

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Retrieves the current value of the specified type of degree of freedom.

Parameters

dof:int — An integer specifying a type of degree of freedom. This value can be 1 (rotation), 2 (x-translation), or 4 (y-translation).

Returns
Number

getSpringAngle

()method 
public function getSpringAngle():Number

Language Version: ActionScript 3.0
Product Version: Flash CS5
Runtime Versions: Flash Player 10, AIR 1.5

Returns the current spring angle.

Returns
Number

getSpringPt

()method 
public function getSpringPt():Point

Language Version: ActionScript 3.0
Product Version: Flash CS5
Runtime Versions: Flash Player 10, AIR 1.5

Returns the current spring point.

Returns
Point

hasPhysics

()method 
public function hasPhysics(recursive:Boolean = true):Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS5
Runtime Versions: Flash Player 10, AIR 1.5

Returns whether the sub-tree (children) of the joint has physics applied.

Parameters

recursive:Boolean (default = true)

Returns
Boolean

hasSpringAngle

()method 
public function hasSpringAngle():Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS5
Runtime Versions: Flash Player 10, AIR 1.5

Returns whether the current spring angle is set.

Returns
Boolean

hasSpringPoint

()method 
public function hasSpringPoint():Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS5
Runtime Versions: Flash Player 10, AIR 1.5

Returns whether a spring point is currently set.

Returns
Boolean

isConstrained

()method 
public function isConstrained(dof:int):Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Returns if the type of degree of freedom is constrained.

Parameters

dof:int — An integer specifying a type of degree of freedom. This value can be 1 (rotation), 2 (x-translation), or 4 (y-translation).

Returns
Boolean

isEnabled

()method 
public function isEnabled(dof:int):*

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Returns if the specified type of degree of freedom is enabled.

Parameters

dof:int — An integer specifying a type of degree of freedom. This value can be 1 (rotation), 2 (x-translation), or 4 (y-translation).

Returns
* — A Boolean value indicating whether the specific degree of freedom is enabled (true), or not (false).

setConstrained

()method 
public function setConstrained(dof:int, constrained:Boolean):void

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Sets the constraint of the specified type of degree of freedom.

Parameters

dof:int — An integer specifying a type of degree of freedom. This value can be 1 (rotation), 2 (x-translation), or 4 (y-translation).
 
constrained:Boolean — Use true to constrain the specified degree of freedom, otherwise use false.

setEnabled

()method 
public function setEnabled(dof:int, enable:Boolean):*

Language Version: ActionScript 3.0
Product Version: Flash CS4
Runtime Versions: Flash Player 10, AIR 1.5

Enables or disables the specified type of degree of freedom.

Parameters

dof:int — An integer specifying a type of degree of freedom. This value can be 1 (rotation), 2 (x-translation), or 4 (y-translation).
 
enable:Boolean — If set to true the specified degree of freedom is enabled.

Returns
*

setSpringAngle

()method 
public function setSpringAngle(angle:Number):void

Language Version: ActionScript 3.0
Product Version: Flash CS5
Runtime Versions: Flash Player 10, AIR 1.5

Sets the current spring angle.

Parameters

angle:Number

setSpringPt

()method 
public function setSpringPt(pt:Point):void

Language Version: ActionScript 3.0
Product Version: Flash CS5
Runtime Versions: Flash Player 10, AIR 1.5

Sets the current spring point.

Parameters

pt:Point