FreeBox (Euclid)

FreeBox Type

Namespace: Euclid
Assembly: Euclid.dll
Base Type: obj

A class containing an array of 8 points representing an arbitrary 3D Box. The points can be in arbitrary position in space.

       7               6
       +---------------+
      /|              /|
     / |             / |
 4  /  |          5 /  |
   +---------------+   |
   |   |           |   |
   |   +-----------|---+
   |  / 3          |  / 2
   | /             | /
   |/              |/
   +---------------+
   0               1

Instance members

Instance member	Description
`this.AsFSharpCode` Full Usage: `this.AsFSharpCode` Returns: `string`	Format FreeBox into an F# code string that can be used to recreate the box. Returns: `string`
`this.AsString` Full Usage: `this.AsString` Returns: `string`	Format Box into string with nice floating point number formatting of X, Y and Z size only. But without type name as in v.ToString() Returns: `string`
`this.GetPt` Full Usage: `this.GetPt` Parameters: i : `int` Returns: `Pnt`	i : `int` Returns: `Pnt`
`this.Move` Full Usage: `this.Move` Parameters: v : `Vec` Returns: `FreeBox`	Returns a FreeBox moved by a vector. v : `Vec` Returns: `FreeBox`
`this.MoveX` Full Usage: `this.MoveX` Parameters: distance : `float` Returns: `FreeBox`	Returns a FreeBox moved by a given distance in X direction. distance : `float` Returns: `FreeBox`
`this.MoveY` Full Usage: `this.MoveY` Parameters: distance : `float` Returns: `FreeBox`	Returns a FreeBox moved by a given distance in Y direction. distance : `float` Returns: `FreeBox`
`this.MoveZ` Full Usage: `this.MoveZ` Parameters: distance : `float` Returns: `FreeBox`	Returns a FreeBox moved by a given distance in Z direction. distance : `float` Returns: `FreeBox`
`this.Origin` Full Usage: `this.Origin` Returns: `Pnt`	The first point of the Box array. Returns: `Pnt`
`this.Points` Full Usage: `this.Points` Returns: `Pnt[]`	The 8 points that make up the box. Returns: `Pnt[]`
`this.Pt0` Full Usage: `this.Pt0` Returns: `Pnt`	Returns: `Pnt`
`this.Pt1` Full Usage: `this.Pt1` Returns: `Pnt`	Returns: `Pnt`
`this.Pt2` Full Usage: `this.Pt2` Returns: `Pnt`	Returns: `Pnt`
`this.Pt3` Full Usage: `this.Pt3` Returns: `Pnt`	Returns: `Pnt`
`this.Pt4` Full Usage: `this.Pt4` Returns: `Pnt`	Returns: `Pnt`
`this.Pt5` Full Usage: `this.Pt5` Returns: `Pnt`	Returns: `Pnt`
`this.Pt6` Full Usage: `this.Pt6` Returns: `Pnt`	Returns: `Pnt`
`this.Pt7` Full Usage: `this.Pt7` Returns: `Pnt`	Returns: `Pnt`
`this.Rotate` Full Usage: `this.Rotate` Parameters: q : `Quaternion` Returns: `FreeBox`	Multiplies (or applies) a Quaternion to the FreeBox. The box is rotated around the World Origin. q : `Quaternion` Returns: `FreeBox`
`this.RotateWithCenter` Full Usage: `this.RotateWithCenter` Parameters: cen : `Pnt` q : `Quaternion` Returns: `FreeBox`	Multiplies (or applies) a Quaternion to the FreeBox around a given center point. cen : `Pnt` q : `Quaternion` Returns: `FreeBox`
`this.Scale` Full Usage: `this.Scale` Parameters: factor : `float` Returns: `FreeBox`	Scales the 3D rectangle by a given factor on world origin (0,0,0) factor : `float` Returns: `FreeBox`
`this.ScaleOn` Full Usage: `this.ScaleOn` Parameters: cen : `Pnt` factor : `float` Returns: `FreeBox`	Scales the 3D rectangle by a given factor on a given center point cen : `Pnt` factor : `float` Returns: `FreeBox`
`this.SizeX` Full Usage: `this.SizeX` Returns: `float`	The length of the Box from Pt0 to Pt1 in the X direction. Returns: `float`
`this.SizeY` Full Usage: `this.SizeY` Returns: `float`	The length of the Box from Pt0 to Pt3 in the Y direction. Returns: `float`
`this.SizeZ` Full Usage: `this.SizeZ` Returns: `float`	The length of the Box from Pt0 to Pt4 in the Z direction. Returns: `float`
`this.Transform` Full Usage: `this.Transform` Parameters: m : `Matrix` Returns: `FreeBox`	Applies or multiplies a 4x4 transformation matrix to the FreeBox. m : `Matrix` Returns: `FreeBox`
`this.TransformRigid` Full Usage: `this.TransformRigid` Parameters: m : `RigidMatrix` Returns: `FreeBox`	Multiplies (or applies) a RigidMatrix to the FreeBox. m : `RigidMatrix` Returns: `FreeBox`
`this.Xaxis` Full Usage: `this.Xaxis` Returns: `Vec`	The vector from Pt0 to Pt1 defining the X axis direction and length. Returns: `Vec`
`this.Yaxis` Full Usage: `this.Yaxis` Returns: `Vec`	The vector from Pt0 to Pt3 defining the Y axis direction and length. Returns: `Vec`
`this.Zaxis` Full Usage: `this.Zaxis` Returns: `Vec`	The vector from Pt0 to Pt4 defining the Z axis direction and length. Returns: `Vec`

Static members

Static member	Description
`FreeBox.createFromBox box` Full Usage: `FreeBox.createFromBox box` Parameters: box : `Box` Returns: `FreeBox`	box : `Box` Returns: `FreeBox`
`FreeBox.createFromEightPoints pts` Full Usage: `FreeBox.createFromEightPoints pts` Parameters: pts : `Pnt[]` Returns: `FreeBox`	pts : `Pnt[]` Returns: `FreeBox`
`FreeBox.createFromFour2DPoints zMin zMax pts` Full Usage: `FreeBox.createFromFour2DPoints zMin zMax pts` Parameters: zMin : `float` zMax : `float` pts : `Pt[]` Returns: `FreeBox`	Creates a FreeBox from four 2D points and a zMin and zMax value. zMin : `float` zMax : `float` pts : `Pt[]` Returns: `FreeBox`
`FreeBox.createFromFour2DPointsArgs (a, b, c, d, zMin, zMax)` Full Usage: `FreeBox.createFromFour2DPointsArgs (a, b, c, d, zMin, zMax)` Parameters: a : `Pt` b : `Pt` c : `Pt` d : `Pt` zMin : `float` zMax : `float` Returns: `FreeBox`	Creates a FreeBox from four 2D points in counter clockwise order and a zMin and zMax value. a : `Pt` b : `Pt` c : `Pt` d : `Pt` zMin : `float` zMax : `float` Returns: `FreeBox`
`FreeBox.move v b` Full Usage: `FreeBox.move v b` Parameters: v : `Vec` b : `FreeBox` Returns: `FreeBox` Modifiers: inline	Move a FreeBox by a vector. Same as FreeBox.translate. v : `Vec` b : `FreeBox` Returns: `FreeBox`
`FreeBox.moveX distance b` Full Usage: `FreeBox.moveX distance b` Parameters: distance : `float` b : `FreeBox` Returns: `FreeBox` Modifiers: inline	Returns the FreeBox moved by a given distance in X direction. distance : `float` b : `FreeBox` Returns: `FreeBox`
`FreeBox.moveY distance b` Full Usage: `FreeBox.moveY distance b` Parameters: distance : `float` b : `FreeBox` Returns: `FreeBox` Modifiers: inline	Returns the FreeBox moved by a given distance in Y direction. distance : `float` b : `FreeBox` Returns: `FreeBox`
`FreeBox.moveZ distance b` Full Usage: `FreeBox.moveZ distance b` Parameters: distance : `float` b : `FreeBox` Returns: `FreeBox` Modifiers: inline	Returns the FreeBox moved by a given distance in Z direction. distance : `float` b : `FreeBox` Returns: `FreeBox`
`FreeBox.rotate q b` Full Usage: `FreeBox.rotate q b` Parameters: q : `Quaternion` b : `FreeBox` Returns: `FreeBox` Modifiers: inline	Multiplies (or applies) a Quaternion to the FreeBox. The box is rotated around the World Origin. q : `Quaternion` b : `FreeBox` Returns: `FreeBox`
`FreeBox.rotateWithCenter cen q b` Full Usage: `FreeBox.rotateWithCenter cen q b` Parameters: cen : `Pnt` q : `Quaternion` b : `FreeBox` Returns: `FreeBox` Modifiers: inline	Multiplies (or applies) a Quaternion to the FreeBox around a given center point. cen : `Pnt` q : `Quaternion` b : `FreeBox` Returns: `FreeBox`
`FreeBox.scale factor b` Full Usage: `FreeBox.scale factor b` Parameters: factor : `float` b : `FreeBox` Returns: `FreeBox` Modifiers: inline	Scales the FreeBox by a given factor. Scale center is World Origin 0,0,0 factor : `float` b : `FreeBox` Returns: `FreeBox`
`FreeBox.transform m b` Full Usage: `FreeBox.transform m b` Parameters: m : `Matrix` b : `FreeBox` Returns: `FreeBox` Modifiers: inline	Applies or multiplies a 4x4 transformation matrix to the FreeBox. m : `Matrix` b : `FreeBox` Returns: `FreeBox`
`FreeBox.transformRigid m b` Full Usage: `FreeBox.transformRigid m b` Parameters: m : `RigidMatrix` b : `FreeBox` Returns: `FreeBox` Modifiers: inline	Multiplies (or applies) a RigidMatrix to the FreeBox. m : `RigidMatrix` b : `FreeBox` Returns: `FreeBox`
`FreeBox.translate v b` Full Usage: `FreeBox.translate v b` Parameters: v : `Vec` b : `FreeBox` Returns: `FreeBox` Modifiers: inline	Translate a FreeBox by a vector. Same as FreeBox.move. v : `Vec` b : `FreeBox` Returns: `FreeBox`