Struct XbimRect3D
  
  
  
  
    Inherited Members
    
      System.ValueType.Equals(System.Object)
    
    
      System.ValueType.GetHashCode()
    
    
      System.Object.Equals(System.Object, System.Object)
    
    
      System.Object.ReferenceEquals(System.Object, System.Object)
    
    
      System.Object.GetType()
    
   
  
  Assembly: Xbim.Common.dll
  Syntax
  
  Constructors
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  XbimRect3D(Double, Double, Double, Double, Double, Double)
  
  
  Declaration
  
    public XbimRect3D(double x, double y, double z, double sizeX, double sizeY, double sizeZ)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Double | x |  | 
      
        | System.Double | y |  | 
      
        | System.Double | z |  | 
      
        | System.Double | sizeX |  | 
      
        | System.Double | sizeY |  | 
      
        | System.Double | sizeZ |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  XbimRect3D(XbimPoint3D)
  
  
  Declaration
  
    public XbimRect3D(XbimPoint3D highpt)
   
  Parameters
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  XbimRect3D(XbimPoint3D, XbimPoint3D)
  
  
  Declaration
  
    public XbimRect3D(XbimPoint3D p1, XbimPoint3D p2)
   
  Parameters
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  XbimRect3D(XbimPoint3D, XbimVector3D)
  
  
  Declaration
  
    public XbimRect3D(XbimPoint3D Position, XbimVector3D Size)
   
  Parameters
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  XbimRect3D(XbimVector3D, XbimVector3D)
  
  
  Declaration
  
    public XbimRect3D(XbimVector3D vMin, XbimVector3D vMax)
   
  Parameters
  
  Properties
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Empty
  
  
  Declaration
  
    public static readonly XbimRect3D Empty { get; }
   
  Property Value
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsEmpty
  
  
  Declaration
  
    public readonly bool IsEmpty { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Location
  
  
  Declaration
  
    public XbimPoint3D Location { get; set; }
   
  Property Value
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Max
  
  
  Declaration
  
    public readonly XbimPoint3D Max { get; }
   
  Property Value
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Min
  
  
  Declaration
  
    public readonly XbimPoint3D Min { get; }
   
  Property Value
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  SizeX
  
  
  Declaration
  
    public double SizeX { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  SizeY
  
  
  Declaration
  
    public double SizeY { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  SizeZ
  
  
  Declaration
  
    public double SizeZ { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Volume
  
  
  Declaration
  
    public readonly double Volume { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  X
  
  
  Declaration
  
    public double X { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Y
  
  
  Declaration
  
    public double Y { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Z
  
  
  Declaration
  
    public double Z { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  Methods
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Centroid()
  Calculates the centre of the 3D rect
Declaration
  
    public XbimPoint3D Centroid()
   
  Returns
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Contains(Double, Double, Double)
  
  
  Declaration
  
    public bool Contains(double x, double y, double z)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Double | x |  | 
      
        | System.Double | y |  | 
      
        | System.Double | z |  | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Contains(XbimPoint3D)
  
  
  Declaration
  
    public bool Contains(XbimPoint3D pt)
   
  Parameters
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Contains(XbimRect3D)
  
  
  Declaration
  
    public bool Contains(XbimRect3D rect)
   
  Parameters
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  FromArray(Byte[])
  Reinitialises the rectangle 3D from the byte array
Declaration
  
    public static XbimRect3D FromArray(byte[] array)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Byte[] | array | 6 doubles, definine, min and max values of the boudning box | 
    
  
  Returns
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  FromString(String)
  Imports values from a string
Declaration
  
    public bool FromString(string Value)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.String | Value | A space-separated string of 6 invariant-culture-formatted floats (x,y,z,sizeX,sizeY,sizeZ) | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean | True if successful. | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Inflate(Double)
  
  
  Declaration
  
    public XbimRect3D Inflate(double d)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Double | d |  | 
    
  
  Returns
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Inflate(Double, Double, Double)
  
  
  Declaration
  
    public XbimRect3D Inflate(double x, double y, double z)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Double | x |  | 
      
        | System.Double | y |  | 
      
        | System.Double | z |  | 
    
  
  Returns
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Inflate(XbimRect3D, Double)
  
  
  Declaration
  
    public static XbimRect3D Inflate(XbimRect3D original, double inflate)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | XbimRect3D | original |  | 
      
        | System.Double | inflate |  | 
    
  
  Returns
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Inflate(XbimRect3D, Double, Double, Double)
  
  
  Declaration
  
    public static XbimRect3D Inflate(XbimRect3D original, double x, double y, double z)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | XbimRect3D | original |  | 
      
        | System.Double | x |  | 
      
        | System.Double | y |  | 
      
        | System.Double | z |  | 
    
  
  Returns
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Intersects(XbimRect3D)
  
  
  Declaration
  
    public bool Intersects(XbimRect3D rect)
   
  Parameters
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsSimilar(XbimRect3D, Double)
  true if the rect fits inside thsi rectangle when it is either inflated or defalted by the tolerance
Declaration
  
    public bool IsSimilar(XbimRect3D rect, double tolerance)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | XbimRect3D | rect |  | 
      
        | System.Double | tolerance |  | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Length()
  Indicative size of the Box along all axis.
Declaration
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Double | Returns the length of the diagonal | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Parse(String)
  
  
  Declaration
  
    public static XbimRect3D Parse(string Value)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.String | Value |  | 
    
  
  Returns
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Radius()
  Returns the radius of the sphere that contains this bounding box rectangle 3D
Declaration
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Double |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Round(Int32)
  Rounds the values of the bounding box to the specified precision
Declaration
  
    public void Round(int digits)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Int32 | digits |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Round(XbimRect3D, Int32)
  Rounds the values of the bounding box to the specified precision and returns a copy
Declaration
  
    public static XbimRect3D Round(XbimRect3D r, int digits)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | XbimRect3D | r |  | 
      
        | System.Int32 | digits |  | 
    
  
  Returns
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  ToDoublesArray()
  Writes the Bounding Box as 6 doubles.
Declaration
  
    public byte[] ToDoublesArray()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Byte[] | An array of doubles (Position followed by Size). | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  ToFloatArray()
  Writes the Bounding Box as 6 floats.
Declaration
  
    public byte[] ToFloatArray()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Byte[] | An array of floats (Position followed by Size). | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  ToString()
  
  
  Declaration
  
    public override string ToString()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.String |  | 
    
  
  Overrides
  System.ValueType.ToString()
  
    |
    Improve this Doc
  
  
    View Source
  
  
  
  Warning: This function assumes no rotation is used for the tranform.
Declaration
  
    public XbimRect3D Transform(XbimMatrix3D composed)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | XbimMatrix3D | composed | The NON-ROTATING transform to apply | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | XbimRect3D | the transformed bounding box. | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  
  Transforms a bounding rect so that it is still axis aligned
Declaration
  
    public static XbimRect3D TransformBy(XbimRect3D rect3d, XbimMatrix3D m)
   
  Parameters
  
  Returns
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Union(XbimPoint3D)
  
  
  Declaration
  
    public void Union(XbimPoint3D highpt)
   
  Parameters
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Union(XbimRect3D)
  
  
  Declaration
  
    public void Union(XbimRect3D bb)
   
  Parameters