202 lines
		
	
	
		
			148 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
		
		
			
		
	
	
			202 lines
		
	
	
		
			148 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
| 
								 | 
							
								---
							 | 
						|||
| 
								 | 
							
								title: "profileStartX"
							 | 
						|||
| 
								 | 
							
								excerpt: ""
							 | 
						|||
| 
								 | 
							
								layout: manual
							 | 
						|||
| 
								 | 
							
								---
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								```js
							 | 
						|||
| 
								 | 
							
								profileStartX(sketch_group: SketchGroup) -> number
							 | 
						|||
| 
								 | 
							
								```
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								### Examples
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								```js
							 | 
						|||
| 
								 | 
							
								const sketch001 = startSketchOn('XY')
							 | 
						|||
| 
								 | 
							
								  |> startProfileAt([5, 2], %)
							 | 
						|||
| 
								 | 
							
								  |> angledLine([-26.6, 50], %)
							 | 
						|||
| 
								 | 
							
								  |> angledLine([90, 50], %)
							 | 
						|||
| 
								 | 
							
								  |> angledLineToX({ angle: 30, to: profileStartX(%) }, %)
							 | 
						|||
| 
								 | 
							
								```
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								```js
							 | 
						|||
| 
								 | 
							
								{
							 | 
						|||
| 
								 | 
							
									// The plane id or face id of the sketch group.
							 | 
						|||
| 
								 | 
							
									entityId: uuid,
							 | 
						|||
| 
								 | 
							
									// The id of the sketch group.
							 | 
						|||
| 
								 | 
							
									id: uuid,
							 | 
						|||
| 
								 | 
							
									// What the sketch is on (can be a plane or a face).
							 | 
						|||
| 
								 | 
							
									on: {
							 | 
						|||
| 
								 | 
							
									// The id of the plane.
							 | 
						|||
| 
								 | 
							
									id: uuid,
							 | 
						|||
| 
								 | 
							
									// Origin of the plane.
							 | 
						|||
| 
								 | 
							
									origin: {
							 | 
						|||
| 
								 | 
							
									x: number,
							 | 
						|||
| 
								 | 
							
									y: number,
							 | 
						|||
| 
								 | 
							
									z: number,
							 | 
						|||
| 
								 | 
							
								},
							 | 
						|||
| 
								 | 
							
									type: "plane",
							 | 
						|||
| 
								 | 
							
									// Type for a plane.
							 | 
						|||
| 
								 | 
							
									value: "XY" | "XZ" | "YZ" | "Custom",
							 | 
						|||
| 
								 | 
							
									// What should the plane’s X axis be?
							 | 
						|||
| 
								 | 
							
									xAxis: {
							 | 
						|||
| 
								 | 
							
									x: number,
							 | 
						|||
| 
								 | 
							
									y: number,
							 | 
						|||
| 
								 | 
							
									z: number,
							 | 
						|||
| 
								 | 
							
								},
							 | 
						|||
| 
								 | 
							
									// What should the plane’s Y axis be?
							 | 
						|||
| 
								 | 
							
									yAxis: {
							 | 
						|||
| 
								 | 
							
									x: number,
							 | 
						|||
| 
								 | 
							
									y: number,
							 | 
						|||
| 
								 | 
							
									z: number,
							 | 
						|||
| 
								 | 
							
								},
							 | 
						|||
| 
								 | 
							
									// The z-axis (normal).
							 | 
						|||
| 
								 | 
							
									zAxis: {
							 | 
						|||
| 
								 | 
							
									x: number,
							 | 
						|||
| 
								 | 
							
									y: number,
							 | 
						|||
| 
								 | 
							
									z: number,
							 | 
						|||
| 
								 | 
							
								},
							 | 
						|||
| 
								 | 
							
								} |
							 | 
						|||
| 
								 | 
							
								{
							 | 
						|||
| 
								 | 
							
									// the face id the sketch is on
							 | 
						|||
| 
								 | 
							
									faceId: uuid,
							 | 
						|||
| 
								 | 
							
									// The id of the face.
							 | 
						|||
| 
								 | 
							
									id: uuid,
							 | 
						|||
| 
								 | 
							
									// The original sketch group id of the object we are sketching on.
							 | 
						|||
| 
								 | 
							
									sketchGroupId: uuid,
							 | 
						|||
| 
								 | 
							
									type: "face",
							 | 
						|||
| 
								 | 
							
									// The tag of the face.
							 | 
						|||
| 
								 | 
							
									value: string,
							 | 
						|||
| 
								 | 
							
									// What should the face’s X axis be?
							 | 
						|||
| 
								 | 
							
									xAxis: {
							 | 
						|||
| 
								 | 
							
									x: number,
							 | 
						|||
| 
								 | 
							
									y: number,
							 | 
						|||
| 
								 | 
							
									z: number,
							 | 
						|||
| 
								 | 
							
								},
							 | 
						|||
| 
								 | 
							
									// What should the face’s Y axis be?
							 | 
						|||
| 
								 | 
							
									yAxis: {
							 | 
						|||
| 
								 | 
							
									x: number,
							 | 
						|||
| 
								 | 
							
									y: number,
							 | 
						|||
| 
								 | 
							
									z: number,
							 | 
						|||
| 
								 | 
							
								},
							 | 
						|||
| 
								 | 
							
									// The z-axis (normal).
							 | 
						|||
| 
								 | 
							
									zAxis: {
							 | 
						|||
| 
								 | 
							
									x: number,
							 | 
						|||
| 
								 | 
							
									y: number,
							 | 
						|||
| 
								 | 
							
									z: number,
							 | 
						|||
| 
								 | 
							
								},
							 | 
						|||
| 
								 | 
							
								},
							 | 
						|||
| 
								 | 
							
									// The position of the sketch group.
							 | 
						|||
| 
								 | 
							
									position: [number, number, number],
							 | 
						|||
| 
								 | 
							
									// The rotation of the sketch group base plane.
							 | 
						|||
| 
								 | 
							
									rotation: [number, number, number, number],
							 | 
						|||
| 
								 | 
							
									// The starting path.
							 | 
						|||
| 
								 | 
							
									start: {
							 | 
						|||
| 
								 | 
							
									// The from point.
							 | 
						|||
| 
								 | 
							
									from: [number, number],
							 | 
						|||
| 
								 | 
							
									// The name of the path.
							 | 
						|||
| 
								 | 
							
									name: string,
							 | 
						|||
| 
								 | 
							
									// The to point.
							 | 
						|||
| 
								 | 
							
									to: [number, number],
							 | 
						|||
| 
								 | 
							
								},
							 | 
						|||
| 
								 | 
							
									// The paths in the sketch group.
							 | 
						|||
| 
								 | 
							
									value: [{
							 | 
						|||
| 
								 | 
							
									// The from point.
							 | 
						|||
| 
								 | 
							
									from: [number, number],
							 | 
						|||
| 
								 | 
							
									// The name of the path.
							 | 
						|||
| 
								 | 
							
									name: string,
							 | 
						|||
| 
								 | 
							
									// The to point.
							 | 
						|||
| 
								 | 
							
									to: [number, number],
							 | 
						|||
| 
								 | 
							
									type: "ToPoint",
							 | 
						|||
| 
								 | 
							
								} |
							 | 
						|||
| 
								 | 
							
								{
							 | 
						|||
| 
								 | 
							
									// arc's direction
							 | 
						|||
| 
								 | 
							
									ccw: string,
							 | 
						|||
| 
								 | 
							
									// the arc's center
							 | 
						|||
| 
								 | 
							
									center: [number, number],
							 | 
						|||
| 
								 | 
							
									// The from point.
							 | 
						|||
| 
								 | 
							
									from: [number, number],
							 | 
						|||
| 
								 | 
							
									// The name of the path.
							 | 
						|||
| 
								 | 
							
									name: string,
							 | 
						|||
| 
								 | 
							
									// The to point.
							 | 
						|||
| 
								 | 
							
									to: [number, number],
							 | 
						|||
| 
								 | 
							
									type: "TangentialArcTo",
							 | 
						|||
| 
								 | 
							
								} |
							 | 
						|||
| 
								 | 
							
								{
							 | 
						|||
| 
								 | 
							
									// The from point.
							 | 
						|||
| 
								 | 
							
									from: [number, number],
							 | 
						|||
| 
								 | 
							
									// The name of the path.
							 | 
						|||
| 
								 | 
							
									name: string,
							 | 
						|||
| 
								 | 
							
									// The to point.
							 | 
						|||
| 
								 | 
							
									to: [number, number],
							 | 
						|||
| 
								 | 
							
									type: "TangentialArc",
							 | 
						|||
| 
								 | 
							
								} |
							 | 
						|||
| 
								 | 
							
								{
							 | 
						|||
| 
								 | 
							
									// The from point.
							 | 
						|||
| 
								 | 
							
									from: [number, number],
							 | 
						|||
| 
								 | 
							
									// The name of the path.
							 | 
						|||
| 
								 | 
							
									name: string,
							 | 
						|||
| 
								 | 
							
									// The to point.
							 | 
						|||
| 
								 | 
							
									to: [number, number],
							 | 
						|||
| 
								 | 
							
									type: "Horizontal",
							 | 
						|||
| 
								 | 
							
									// The x coordinate.
							 | 
						|||
| 
								 | 
							
									x: number,
							 | 
						|||
| 
								 | 
							
								} |
							 | 
						|||
| 
								 | 
							
								{
							 | 
						|||
| 
								 | 
							
									// The from point.
							 | 
						|||
| 
								 | 
							
									from: [number, number],
							 | 
						|||
| 
								 | 
							
									// The name of the path.
							 | 
						|||
| 
								 | 
							
									name: string,
							 | 
						|||
| 
								 | 
							
									// The to point.
							 | 
						|||
| 
								 | 
							
									to: [number, number],
							 | 
						|||
| 
								 | 
							
									type: "AngledLineTo",
							 | 
						|||
| 
								 | 
							
									// The x coordinate.
							 | 
						|||
| 
								 | 
							
									x: number,
							 | 
						|||
| 
								 | 
							
									// The y coordinate.
							 | 
						|||
| 
								 | 
							
									y: number,
							 | 
						|||
| 
								 | 
							
								} |
							 | 
						|||
| 
								 | 
							
								{
							 | 
						|||
| 
								 | 
							
									// The from point.
							 | 
						|||
| 
								 | 
							
									from: [number, number],
							 | 
						|||
| 
								 | 
							
									// The name of the path.
							 | 
						|||
| 
								 | 
							
									name: string,
							 | 
						|||
| 
								 | 
							
									// The to point.
							 | 
						|||
| 
								 | 
							
									to: [number, number],
							 | 
						|||
| 
								 | 
							
									type: "Base",
							 | 
						|||
| 
								 | 
							
								}],
							 | 
						|||
| 
								 | 
							
									// The x-axis of the sketch group base plane in the 3D space
							 | 
						|||
| 
								 | 
							
									xAxis: {
							 | 
						|||
| 
								 | 
							
									x: number,
							 | 
						|||
| 
								 | 
							
									y: number,
							 | 
						|||
| 
								 | 
							
									z: number,
							 | 
						|||
| 
								 | 
							
								},
							 | 
						|||
| 
								 | 
							
									// The y-axis of the sketch group base plane in the 3D space
							 | 
						|||
| 
								 | 
							
									yAxis: {
							 | 
						|||
| 
								 | 
							
									x: number,
							 | 
						|||
| 
								 | 
							
									y: number,
							 | 
						|||
| 
								 | 
							
									z: number,
							 | 
						|||
| 
								 | 
							
								},
							 | 
						|||
| 
								 | 
							
									// The z-axis of the sketch group base plane in the 3D space
							 | 
						|||
| 
								 | 
							
									zAxis: {
							 | 
						|||
| 
								 | 
							
									x: number,
							 | 
						|||
| 
								 | 
							
									y: number,
							 | 
						|||
| 
								 | 
							
									z: number,
							 | 
						|||
| 
								 | 
							
								},
							 | 
						|||
| 
								 | 
							
								}
							 | 
						|||
| 
								 | 
							
								```
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								### Returns
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								`number`
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								
							 | 
						|||
| 
								 | 
							
								
							 |