Constructor
new KinematicsComponentBehaviorMapped()
Classes
Methods
getBelt() → {KinematicsBelt}
Retrieves the belt object for this component (applicable to componentType.mapped with mapped type set to componentType.belt)
Returns:
Belt Object
- Type
- KinematicsBelt
getHelicalFactor() → {number}
Retrieves the helical factor
Returns:
Helical Factor
- Type
- number
getMappedTargetComponent() → {KinematicsComponent}
Retrieves the mapped target component (applicable to componentType.mapped)
Returns:
Component
- Type
- KinematicsComponent
getMappedType() → {componentType}
Retrieves the mapped type of a component (applicable to componentType.mapped)
Returns:
Mapped Type
- Type
- componentType
getPrismaticPlanePlane() → {Plane}
Retrieves the plane for the prismatic plane component (applicable to componentType.mapped with mapped type set to componentType.prismaticPlane)
Returns:
Plane
- Type
- Plane
getPrismaticPlaneTip() → {Point3}
Retrieves the tip for the prismatic plane component (applicable to componentType.mapped with mapped type set to componentType.prismaticPlane)
Returns:
Tip
- Type
- Point3
setHelicalFactor(helicalFactor)
Sets the helical factor
Parameters:
| Name | Type | Description |
|---|---|---|
helicalFactor |
number | Helical Factor |
setMappedTargetComponent(component)
Sets the mapped target component (applicable to componentType.mapped)
Parameters:
| Name | Type | Description |
|---|---|---|
component |
KinematicsComponent | Component |
setMappedType(mappedType)
Sets the mapped type of a component (applicable to componentType.mapped)
Parameters:
| Name | Type | Description |
|---|---|---|
mappedType |
componentType | Mapped Type |
setPrismaticPlanePlane(plane)
Sets the plane for the prismatic plane component (applicable to componentType.mapped with mapped type set to componentType.prismaticPlane)
Parameters:
| Name | Type | Description |
|---|---|---|
plane |
Plane | Plane |
setPrismaticPlaneTip(tip)
Sets the tip for the prismatic plane component (applicable to componentType.mapped with mapped type set to componentType.prismaticPlane)
Parameters:
| Name | Type | Description |
|---|---|---|
tip |
Point3 | Tip |