[Bf-blender-cvs] [8eddcdfd590] temp-sybren-usd-patch-02: USD: clarification of USDAbstractWriter::is_supported()

[Sybren A. Stüvel]

Commit: 8eddcdfd590d76fc5898c8bced2b8455ed1ad3ad
Author: Sybren A. Stüvel
Date:   Tue Nov 26 14:16:05 2019 +0100
Branches: temp-sybren-usd-patch-02
https://developer.blender.org/rB8eddcdfd590d76fc5898c8bced2b8455ed1ad3ad

USD: clarification of USDAbstractWriter::is_supported()

===================================================================

M	source/blender/usd/intern/usd_writer_abstract.h

===================================================================

diff --git a/source/blender/usd/intern/usd_writer_abstract.h b/source/blender/usd/intern/usd_writer_abstract.h
index 6cfdf5a8ae3..548c8cf9659 100644
--- a/source/blender/usd/intern/usd_writer_abstract.h
+++ b/source/blender/usd/intern/usd_writer_abstract.h
@@ -50,8 +50,13 @@ class USDAbstractWriter : public AbstractHierarchyWriter {
 
   virtual void write(HierarchyContext &context) override;
 
-  /* Returns true iff the data to be written is actually supported. This would, for example, allow
-   * a hypothetical camera writer accept a perspective camera but reject an orthogonal one. */
+  /* Returns true if the data to be written is actually supported. This would, for example, allow a
+   * hypothetical camera writer accept a perspective camera but reject an orthogonal one.
+   *
+   * Returning false from a transform writer will prevent the object and all its decendants from
+   * being exported. Returning false from a data writer (object data, hair, or particles) will
+   * only prevent that data from being written (and thus cause the object to be exported as an
+   * Empty). */
   virtual bool is_supported(const Object *object) const;
 
   const pxr::SdfPath &usd_path() const;