diff options
Diffstat (limited to 'third_party/rust/binary-space-partition')
| -rw-r--r-- | third_party/rust/binary-space-partition/.cargo-checksum.json | 1 | ||||
| -rw-r--r-- | third_party/rust/binary-space-partition/Cargo.toml | 14 | ||||
| -rw-r--r-- | third_party/rust/binary-space-partition/LICENSE | 374 | ||||
| -rw-r--r-- | third_party/rust/binary-space-partition/README.md | 5 | ||||
| -rw-r--r-- | third_party/rust/binary-space-partition/src/lib.rs | 220 |
5 files changed, 614 insertions, 0 deletions
diff --git a/third_party/rust/binary-space-partition/.cargo-checksum.json b/third_party/rust/binary-space-partition/.cargo-checksum.json new file mode 100644 index 0000000000..2b529fc240 --- /dev/null +++ b/third_party/rust/binary-space-partition/.cargo-checksum.json @@ -0,0 +1 @@ +{"files":{"Cargo.toml":"aeff622e55caf0aaaa01d75ad13ea07be748fbecd2985a81aa6c7c0de5d07241","LICENSE":"b946744aeda89b467929585fe8eeb5461847695220c1b168fb375d8abd4ea3d0","README.md":"ed45cabc231f18f0972348f0e230d45c92495c31e4a06eb105e8259ed9b582b3","src/lib.rs":"f97ad15f6ae8664f4978aaa057c0a8e27a050dc1ea79f8b66506d8fd8c7a22f9"},"package":"88ceb0d16c4fd0e42876e298d7d3ce3780dd9ebdcbe4199816a32c77e08597ff"}
\ No newline at end of file diff --git a/third_party/rust/binary-space-partition/Cargo.toml b/third_party/rust/binary-space-partition/Cargo.toml new file mode 100644 index 0000000000..547b3cbf7c --- /dev/null +++ b/third_party/rust/binary-space-partition/Cargo.toml @@ -0,0 +1,14 @@ +[package] +name = "binary-space-partition" +version = "0.1.2" +authors = ["Dzmitry Malyshau <kvark@mozilla.com>"] +description = "Abstract BSP tree" +license = "MPL-2.0" +repository = "https://github.com/kvark/binary-space-partition" +keywords = ["geometry", "math"] +documentation = "https://docs.rs/binary-space-partition" + +[dependencies] + +[dev-dependencies] +rand = "0.3" diff --git a/third_party/rust/binary-space-partition/LICENSE b/third_party/rust/binary-space-partition/LICENSE new file mode 100644 index 0000000000..398385c9fb --- /dev/null +++ b/third_party/rust/binary-space-partition/LICENSE @@ -0,0 +1,374 @@ + Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" +means each individual or legal entity that creates, contributes to +the creation of, or owns Covered Software. + +1.2. "Contributor Version" +means the combination of the Contributions of others (if any) used +by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" +means Covered Software of a particular Contributor. + +1.4. "Covered Software" +means Source Code Form to which the initial Contributor has attached +the notice in Exhibit A, the Executable Form of such Source Code +Form, and Modifications of such Source Code Form, in each case +including portions thereof. + +1.5. "Incompatible With Secondary Licenses" +means + +(a) that the initial Contributor has attached the notice described +in Exhibit B to the Covered Software; or + +(b) that the Covered Software was made available under the terms of +version 1.1 or earlier of the License, but not also under the +terms of a Secondary License. + +1.6. "Executable Form" +means any form of the work other than Source Code Form. + +1.7. "Larger Work" +means a work that combines Covered Software with other material, in +a separate file or files, that is not Covered Software. + +1.8. "License" +means this document. + +1.9. "Licensable" +means having the right to grant, to the maximum extent possible, +whether at the time of the initial grant or subsequently, any and +all of the rights conveyed by this License. + +1.10. "Modifications" +means any of the following: + +(a) any file in Source Code Form that results from an addition to, +deletion from, or modification of the contents of Covered +Software; or + +(b) any new file in Source Code Form that contains any Covered +Software. + +1.11. "Patent Claims" of a Contributor +means any patent claim(s), including without limitation, method, +process, and apparatus claims, in any patent Licensable by such +Contributor that would be infringed, but for the grant of the +License, by the making, using, selling, offering for sale, having +made, import, or transfer of either its Contributions or its +Contributor Version. + +1.12. "Secondary License" +means either the GNU General Public License, Version 2.0, the GNU +Lesser General Public License, Version 2.1, the GNU Affero General +Public License, Version 3.0, or any later versions of those +licenses. + +1.13. "Source Code Form" +means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") +means an individual or a legal entity exercising rights under this +License. For legal entities, "You" includes any entity that +controls, is controlled by, or is under common control with You. For +purposes of this definition, "control" means (a) the power, direct +or indirect, to cause the direction or management of such entity, +whether by contract or otherwise, or (b) ownership of more than +fifty percent (50%) of the outstanding shares or beneficial +ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) +Licensable by such Contributor to use, reproduce, make available, +modify, display, perform, distribute, and otherwise exploit its +Contributions, either on an unmodified basis, with Modifications, or +as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer +for sale, have made, import, and otherwise transfer either its +Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; +or + +(b) for infringements caused by: (i) Your and any other third party's +modifications of Covered Software, or (ii) the combination of its +Contributions with other software (except as part of its Contributor +Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of +its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code +Form, as described in Section 3.1, and You must inform recipients of +the Executable Form how they can obtain a copy of such Source Code +Form by reasonable means in a timely manner, at a charge no more +than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this +License, or sublicense it under different terms, provided that the +license for the Executable Form does not attempt to limit or alter +the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + +This Source Code Form is subject to the terms of the Mozilla Public +License, v. 2.0. If a copy of the MPL was not distributed with this +file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + +This Source Code Form is "Incompatible With Secondary Licenses", as +defined by the Mozilla Public License, v. 2.0. + diff --git a/third_party/rust/binary-space-partition/README.md b/third_party/rust/binary-space-partition/README.md new file mode 100644 index 0000000000..2df4d5f35f --- /dev/null +++ b/third_party/rust/binary-space-partition/README.md @@ -0,0 +1,5 @@ +# binary-space-partition +[](https://travis-ci.org/kvark/binary-space-partition) [](https://crates.io/crates/binary-space-partition) [](https://docs.rs/binary-space-partition) + +Binary Space Partitioning (BSP) tree. +Designed to be used with [plane-split](https://github.com/kvark/plane-split) crate. diff --git a/third_party/rust/binary-space-partition/src/lib.rs b/third_party/rust/binary-space-partition/src/lib.rs new file mode 100644 index 0000000000..af2c09103b --- /dev/null +++ b/third_party/rust/binary-space-partition/src/lib.rs @@ -0,0 +1,220 @@ +/*! +Binary Space Partitioning (BSP) + +Provides an abstract `BspNode` structure, which can be seen as a tree. +Useful for quickly ordering polygons along a particular view vector. +Is not tied to a particular math library. +*/ +#![warn(missing_docs)] + +use std::cmp; + + +/// The result of one plane being cut by another one. +/// The "cut" here is an attempt to classify a plane as being +/// in front or in the back of another one. +#[derive(Debug)] +pub enum PlaneCut<T> { + /// The planes are one the same geometrical plane. + Sibling(T), + /// Planes are different, thus we can either determine that + /// our plane is completely in front/back of another one, + /// or split it into these sub-groups. + Cut { + /// Sub-planes in front of the base plane. + front: Vec<T>, + /// Sub-planes in the back of the base plane. + back: Vec<T>, + }, +} + +/// A plane abstracted to the matter of partitioning. +pub trait Plane: Sized + Clone { + /// Try to cut a different plane by this one. + fn cut(&self, Self) -> PlaneCut<Self>; + /// Check if a different plane is aligned in the same direction + /// as this one. + fn is_aligned(&self, &Self) -> bool; +} + +/// Add a list of planes to a particular front/end branch of some root node. +fn add_side<T: Plane>(side: &mut Option<Box<BspNode<T>>>, mut planes: Vec<T>) { + if planes.len() != 0 { + if side.is_none() { + *side = Some(Box::new(BspNode::new())); + } + let mut node = side.as_mut().unwrap(); + for p in planes.drain(..) { + node.insert(p) + } + } +} + + +/// A node in the `BspTree`, which can be considered a tree itself. +#[derive(Clone, Debug)] +pub struct BspNode<T> { + values: Vec<T>, + front: Option<Box<BspNode<T>>>, + back: Option<Box<BspNode<T>>>, +} + +impl<T> BspNode<T> { + /// Create a new node. + pub fn new() -> Self { + BspNode { + values: Vec::new(), + front: None, + back: None, + } + } + + /// Check if this node is a leaf of the tree. + pub fn is_leaf(&self) -> bool { + self.front.is_none() && self.back.is_none() + } + + /// Get the tree depth starting with this node. + pub fn get_depth(&self) -> usize { + if self.values.is_empty() { + return 0 + } + let df = match self.front { + Some(ref node) => node.get_depth(), + None => 0, + }; + let db = match self.back { + Some(ref node) => node.get_depth(), + None => 0, + }; + 1 + cmp::max(df, db) + } +} + +impl<T: Plane> BspNode<T> { + /// Insert a value into the sub-tree starting with this node. + /// This operation may spawn additional leafs/branches of the tree. + pub fn insert(&mut self, value: T) { + if self.values.is_empty() { + self.values.push(value); + return + } + match self.values[0].cut(value) { + PlaneCut::Sibling(value) => self.values.push(value), + PlaneCut::Cut { front, back } => { + add_side(&mut self.front, front); + add_side(&mut self.back, back); + } + } + } + + /// Build the draw order of this sub-tree into an `out` vector, + /// so that the contained planes are sorted back to front according + /// to the view vector defines as the `base` plane front direction. + pub fn order(&self, base: &T, out: &mut Vec<T>) { + let (former, latter) = match self.values.first() { + None => return, + Some(ref first) if base.is_aligned(first) => (&self.front, &self.back), + Some(_) => (&self.back, &self.front), + }; + + if let Some(ref node) = *former { + node.order(base, out); + } + + out.extend_from_slice(&self.values); + + if let Some(ref node) = *latter { + node.order(base, out); + } + } +} + + +#[cfg(test)] +mod tests { + extern crate rand; + use super::*; + use self::rand::Rng; + + #[derive(Clone, Debug, PartialEq)] + struct Plane1D(i32, bool); + + impl Plane for Plane1D { + fn cut(&self, plane: Self) -> PlaneCut<Self> { + if self.0 == plane.0 { + PlaneCut::Sibling(plane) + } else if (plane.0 > self.0) == self.1 { + PlaneCut::Cut { + front: vec![plane], + back: vec![], + } + } else { + PlaneCut::Cut { + front: vec![], + back: vec![plane], + } + } + } + + fn is_aligned(&self, plane: &Self) -> bool { + self.1 == plane.1 + } + } + + + #[test] + fn test_add_side() { + let mut node_opt = None; + let p0: Vec<Plane1D> = Vec::new(); + add_side(&mut node_opt, p0); + assert!(node_opt.is_none()); + + let p1 = Plane1D(1, true); + add_side(&mut node_opt, vec![p1.clone()]); + assert_eq!(node_opt.as_ref().unwrap().values, vec![p1.clone()]); + assert!(node_opt.as_ref().unwrap().is_leaf()); + + let p23 = vec![Plane1D(0, false), Plane1D(2, false)]; + add_side(&mut node_opt, p23); + let node = node_opt.unwrap(); + assert_eq!(node.values, vec![p1.clone()]); + assert!(node.front.is_some() && node.back.is_some()); + } + + #[test] + fn test_insert_depth() { + let mut node = BspNode::new(); + assert_eq!(node.get_depth(), 0); + node.insert(Plane1D(0, true)); + assert_eq!(node.get_depth(), 1); + node.insert(Plane1D(6, true)); + assert_eq!(node.get_depth(), 2); + node.insert(Plane1D(8, true)); + assert_eq!(node.get_depth(), 3); + node.insert(Plane1D(6, true)); + assert_eq!(node.get_depth(), 3); + node.insert(Plane1D(-5, false)); + assert_eq!(node.get_depth(), 3); + } + + #[test] + fn test_order() { + let mut rng = rand::thread_rng(); + let mut node = BspNode::new(); + let mut out = Vec::new(); + + node.order(&Plane1D(0, true), &mut out); + assert!(out.is_empty()); + + for _ in 0 .. 100 { + let plane = Plane1D(rng.gen(), rng.gen()); + node.insert(plane); + } + + node.order(&Plane1D(0, true), &mut out); + let mut out2 = out.clone(); + out2.sort_by_key(|p| -p.0); + assert_eq!(out, out2); + } +} |