Refactor the code (PixarAnimationStudios#90)

(cherry picked from commit 076abbae4d2bbed42ab4d465cef925b6aa06c245)

pxr/imaging/hd/simpleText.cpp

@@ -1,5 +1,5 @@
 //
-// Copyright 2016 Pixar
+// Copyright 2021 Pixar
 //
 // Licensed under the Apache License, Version 2.0 (the "Apache License")
 // with the following modification; you may not use this file except in
@@ -24,7 +24,6 @@
 #include "pxr/pxr.h"
 #include "pxr/imaging/hd/simpleText.h"
 #include "pxr/imaging/hd/tokens.h"
-#include "pxr/base/tf/envSetting.h"
 
 PXR_NAMESPACE_OPEN_SCOPE
 

pxr/imaging/hd/simpleTextTopology.cpp

@@ -1,5 +1,5 @@
 //
-// Copyright 2016 Pixar
+// Copyright 2021 Pixar
 //
 // Licensed under the Apache License, Version 2.0 (the "Apache License")
 // with the following modification; you may not use this file except in
@@ -58,14 +58,13 @@ HdSimpleTextTopology::operator==(HdSimpleTextTopology const &other) const
 {
     HD_TRACE_FUNCTION();
 
-    // no need to compare _adajency and _quadInfo
-    return (_pointCount == other._pointCount);
+    return _pointCount == other._pointCount;
 }
 
 bool
 HdSimpleTextTopology::operator!=(HdSimpleTextTopology const &other) const
 {
-    return !(*this == other);
+    return _pointCount != other._pointCount;
 }
 
 HdTopology::ID
@@ -74,6 +73,7 @@ HdSimpleTextTopology::ComputeHash() const
     HD_TRACE_FUNCTION();
 
     HdTopology::ID hash = 0;
+    // We only need to hash the point count.
     hash = ArchHash64((const char*)&_pointCount, sizeof(int), hash);
 
     // Note: We don't hash topological visibility, because it is treated as a
@@ -84,7 +84,7 @@ HdSimpleTextTopology::ComputeHash() const
 std::ostream&
 operator << (std::ostream &out, HdSimpleTextTopology const &topo)
 {
-    out << "";
+    out << "(" << topo.GetPointCount() << ")";
     return out;
 }
 

pxr/imaging/hd/simpleTextTopology.h

@@ -1,5 +1,5 @@
 //
-// Copyright 2016 Pixar
+// Copyright 2021 Pixar
 //
 // Licensed under the Apache License, Version 2.0 (the "Apache License")
 // with the following modification; you may not use this file except in
@@ -25,18 +25,20 @@
 #define PXR_IMAGING_HD_SIMPLE_TEXT_TOPOLOGY_H
 
 #include "pxr/pxr.h"
-#include "pxr/imaging/hd/api.h"
-#include "pxr/imaging/hd/version.h"
 #include "pxr/imaging/hd/topology.h"
-#include "pxr/imaging/hd/tokens.h"
-
-#include "pxr/base/vt/array.h"
-#include "pxr/base/vt/value.h"
-
-#include "pxr/base/tf/token.h"
 
 PXR_NAMESPACE_OPEN_SCOPE
 
+/// \class HdSimpleTextTopology
+///
+/// Topology data for simpleText.
+///
+/// HdSimpleTextTopology holds the raw input topology data for simpleText.
+///
+/// The geometries of the text render items are always triangles, and we provide separate position
+/// for each point. So the indices are always from zero to the count of points. The topology only
+/// diffs by pointCount.
+///
 class HdSimpleTextTopology : public HdTopology {
 public:
     HD_API
@@ -52,11 +54,12 @@ class HdSimpleTextTopology : public HdTopology {
     HD_API
     virtual ID ComputeHash() const;
 
+    /// Returns point count of the text geometry.
     int GetPointCount() const {
         return _pointCount;
     }
 
-    /// Equality check between two basisCurves topologies.
+    /// Equality check between two simpleText topologies.
     HD_API
         bool operator==(HdSimpleTextTopology const &other) const;
     HD_API

pxr/imaging/hdSt/shaders/text.glslfx

@@ -116,14 +116,16 @@ out VSOutputShaderData
 {
 	// The vertex position.
 	vec4 Peye;
-	// The interpolated texture coordinates.
-	vec2 UV;
+
+    vec2 UV;
 	vec2 TriType;
+    vec3 TextColor;
 }outData;
 
 // Vertex shader - for shader based text.
 void main(void)
 {
+    // The position in object space.
 	vec4 position = vec4(HdGet_points(), 1.0);
 
 	// Transform the position from object space to clip space for output.
@@ -135,6 +137,12 @@ void main(void)
 	outData.UV = HdGet_textUV();
 	outData.TriType = HdGet_triType();
 
+    // Pass the text color.
+    outData.TextColor = vec3(1.0, 0.5, 0.5);
+#ifdef HD_HAS_displayColor
+    outData.TextColor = HdGet_displayColor().rgb;
+#endif
+
 	gl_Position = vec4(GetProjectionMatrix() * outData.Peye);
     gl_Position.z -= gl_Position.w* 2.0 * GetDepthPriority();
 	ApplyClipPlanes(outData.Peye);
@@ -148,18 +156,17 @@ in VSOutputShaderData
 {
 	// The vertex position.
 	vec4 Peye;
-	// The interpolated texture coordinates.
-	vec2 UV;
+ 
+    vec2 UV;
 	vec2 TriType;
+    vec3 TextColor;
 }inData;
 
 // Pixel shader - for shader based text.
 void main(void)
 {
 	float alpha = 1.0;
-#ifdef HD_HAS_displayOpacity
-	alpha = HdGet_displayOpacity().r;
-#endif
+
     vec2 uv                 = inData.UV;
     vec2 triType            = inData.TriType;
 
@@ -207,13 +214,12 @@ void main(void)
             alpha *= dist < -0.5 ? 1.0 : ( dist < 0.5 ? (0.5 - dist) : 0.0);
     }
 
-	vec3 displayColor = vec3(1.0, 0.5, 0.5);
-#ifdef HD_HAS_displayColor
-	displayColor = HdGet_displayColor().rgb;
-#endif
-
-    vec4 finalColor = vec4(displayColor * alpha, alpha);
-    finalColor = ApplyColorOverrides(finalColor);
+    // The text primitive have alpha natively. So here we first get the override color, then
+    // multiply the alpha of the primitive with the override alpha, and finally set the alpha
+    // to the final color.
+    vec4 overrideColor = ApplyColorOverrides(vec4(inData.TextColor.rgb, 1.0));
+    alpha = alpha * overrideColor.a;
+    vec4 finalColor = vec4(overrideColor.rgb * alpha, alpha);
 
     vec3 Peye = inData.Peye.xyz / inData.Peye.w;
     RenderOutput(vec4(Peye, 1), vec3(0, 0, 1), finalColor, vec4(1));

pxr/imaging/hdSt/simpleText.cpp

@@ -38,15 +38,9 @@
 
 #include "pxr/base/arch/hash.h"
 
-#include "pxr/base/gf/matrix4d.h"
-#include "pxr/base/gf/matrix4f.h"
-#include "pxr/base/gf/vec2d.h"
-#include "pxr/base/gf/vec2i.h"
-
 #include "pxr/imaging/hd/bufferSource.h"
 #include "pxr/imaging/hd/computation.h"
 #include "pxr/imaging/hd/repr.h"
-#include "pxr/imaging/hd/vertexAdjacency.h"
 #include "pxr/imaging/hd/vtBufferSource.h"
 #include "pxr/base/vt/value.h"
 
@@ -56,6 +50,7 @@ HdStSimpleText::HdStSimpleText(SdfPath const& id)
     : HdSimpleText(id)
     , _topology()
     , _topologyId(0)
+    , _customDirtyBitsInUse(0)
     , _refineLevel(0)
     , _displayOpacity(false)
 {
@@ -197,19 +192,15 @@ HdStSimpleText::_UpdateDrawItem(HdSceneDelegate *sceneDelegate,
     // XXX: _PopulateTopology should be split into two phase
     //      for scene dirtybits and for repr dirtybits.
     if (*dirtyBits & (HdChangeTracker::DirtyTopology
-        | HdChangeTracker::DirtyDisplayStyle)) {
+        | HdChangeTracker::DirtyDisplayStyle
+        | DirtyIndices)) {
         _PopulateTopology(
             sceneDelegate, renderParam, drawItem, dirtyBits);
     }
 
     /* PRIMVAR */
     if ((*dirtyBits & HdChangeTracker::NewRepr) ||
         HdChangeTracker::IsAnyPrimvarDirty(*dirtyBits, id)) {
-        // XXX: curves don't use refined vertex primvars, however,
-        // the refined renderpass masks the dirtiness of non-refined vertex
-        // primvars, so we need to see refined dirty for updating coarse
-        // vertex primvars if there is only refined reprs being updated.
-        // we'll fix the change tracking in order to address this craziness.
         _PopulateVertexPrimvars(
             sceneDelegate, renderParam, drawItem, dirtyBits);
     }
@@ -220,8 +211,7 @@ HdStSimpleText::_UpdateDrawItem(HdSceneDelegate *sceneDelegate,
     // work with delegates that don't keep information around once extracted.
     *dirtyBits &= ~HdChangeTracker::AllSceneDirtyBits;
 
-    // Topology and VertexPrimvar may be null, if the curve has zero line
-    // segments.
+    // Topology and VertexPrimvar may be null.
     TF_VERIFY(drawItem->GetConstantPrimvarRange());
 }
 
@@ -260,7 +250,7 @@ HdStSimpleText::_PopulateTopology(HdSceneDelegate *sceneDelegate,
         _topologyId = ArchHash64((const char*)&refined, sizeof(refined),
             _topologyId);
 
-        // ask the registry if there is a sharable basisCurves topology
+        // ask the registry if there is a sharable simpleText topology
         HdInstance<HdSt_SimpleTextTopologySharedPtr> topologyInstance =
             resourceRegistry->RegisterSimpleTextTopology(_topologyId);
 
@@ -282,7 +272,9 @@ HdStSimpleText::_PopulateTopology(HdSceneDelegate *sceneDelegate,
         }
     }
 
+    if ((*dirtyBits & DirtyIndices) == 0) return;
     TfToken indexToken;
+    *dirtyBits &= ~DirtyIndices;
     indexToken = HdTokens->indices;
 
     HdInstance<HdBufferArrayRangeSharedPtr> rangeInstance =
@@ -373,7 +365,7 @@ HdStSimpleText::_PopulateVertexPrimvars(HdSceneDelegate *sceneDelegate,
         // are points
         if (!_topology) {
             if (primvar.name == HdTokens->points) {
-                TF_CODING_ERROR("No topology set for BasisCurve %s",
+                TF_CODING_ERROR("No topology set for SimpleText %s",
                     id.GetName().c_str());
                 break;
             }
@@ -464,12 +456,13 @@ HdStSimpleText::_UpdateRepr(HdSceneDelegate *sceneDelegate,
     }
 
     // Filter custom dirty bits to only those in use.
-    *dirtyBits &= (HdChangeTracker::AllSceneDirtyBits |
+    *dirtyBits &= (_customDirtyBitsInUse | 
+        HdChangeTracker::AllSceneDirtyBits |
         HdChangeTracker::NewRepr);
 
     if (TfDebug::IsEnabled(HD_RPRIM_UPDATED)) {
         TfDebug::Helper().Msg(
-            "HdStBasisCurves::_UpdateRepr for %s : Repr = %s\n",
+            "HdStSimpleText::_UpdateRepr for %s : Repr = %s\n",
             GetId().GetText(), reprToken.GetText());
         HdChangeTracker::DumpDirtyBits(*dirtyBits);
     }
@@ -551,6 +544,11 @@ HdStSimpleText::Finalize(HdRenderParam *renderParam)
 HdDirtyBits
 HdStSimpleText::_PropagateDirtyBits(HdDirtyBits bits) const
 {
+    // propagate scene-based dirtyBits into rprim-custom dirtyBits
+    if (bits & HdChangeTracker::DirtyTopology) {
+        bits |= _customDirtyBitsInUse & DirtyIndices;
+    }
+
     return bits;
 }
 
@@ -566,6 +564,8 @@ HdStSimpleText::_InitRepr(TfToken const &reprToken, HdDirtyBits *dirtyBits)
         HdReprSharedPtr &repr = _reprs.back().second;
 
         *dirtyBits |= HdChangeTracker::NewRepr;
+        _customDirtyBitsInUse |= DirtyIndices;
+        *dirtyBits |= DirtyIndices;
 
         HdRepr::DrawItemUniquePtr drawItem =
             std::make_unique<HdStDrawItem>(&_sharedData);

pxr/imaging/hdSt/simpleText.h

@@ -1,5 +1,5 @@
 //
-// Copyright 2016 Pixar
+// Copyright 2021 Pixar
 //
 // Licensed under the Apache License, Version 2.0 (the "Apache License")
 // with the following modification; you may not use this file except in
@@ -28,7 +28,6 @@
 #include "pxr/imaging/hdSt/api.h"
 #include "pxr/imaging/hd/version.h"
 #include "pxr/imaging/hd/simpleText.h"
-#include "pxr/imaging/hd/drawingCoord.h"
 #include "pxr/imaging/hd/enums.h"
 #include "pxr/imaging/hd/perfLog.h"
 
@@ -43,31 +42,13 @@ class HdStDrawItem;
 using HdSt_SimpleTextTopologySharedPtr =
     std::shared_ptr<class HdSt_SimpleTextTopology>;
 
-/// \class HdStBasisCurves
+/// \class HdStSimpleText
 ///
-/// A collection of curves using a particular basis.
+/// A single line single style text.
 ///
-/// Render mode is dependent on both the HdBasisCurvesGeomStyle, refinement 
-/// level, and the authored primvars.
+/// Currently we only support render the text using shader based technique. Next we will support
+/// texture based technique.
 ///
-/// If style is set to HdBasisCurvesGeomStyleWire, the curves will always draw
-/// as infinitely thin wires.  Cubic curves will be refined if complexity is
-/// above 0, otherwise they draw the unrefined control points. (This may
-/// provide a misleading representation for Catmull-Rom and Bspline curves.)
-///
-/// If style is set to HdBasisCurvesGeomStylePatch, the curves will draw as
-/// patches ONLY if refinement level is above 0.  Otherwise, they draw
-/// as the unrefined control points (see notes on HdBasisCurvesGeomStyleWire).
-///
-/// Curves rendered as patches may be rendered as ribbons or halftubes.
-/// Curves with primvar authored normals will always render as ribbons.
-/// Curves without primvar authored normals are assumed to be round and may be
-/// rendered in one of three styles:
-///   * if complexity is 1, a camera facing normal is used
-///   * if complexity is 2, a fake "bumped" round normal is used
-///   * if complexity is 3 or above, the patch is displaced into a half tube
-/// We plan for future checkins will remove the need for the camera facing normal
-/// mode, using the fake "bumped" round normal instead.
 class HdStSimpleText final: public HdSimpleText
 {
 public:
@@ -120,13 +101,18 @@ class HdStSimpleText final: public HdSimpleText
         bool updateGeometricShader);
 
 private:
+    enum DirtyBits : HdDirtyBits {
+        DirtyIndices = HdChangeTracker::CustomBitsBegin,
+    };
+
     void _UpdateDrawItem(HdSceneDelegate *sceneDelegate,
         HdRenderParam *renderParam,
         HdStDrawItem *drawItem,
         HdDirtyBits *dirtyBits);
 
     HdSt_SimpleTextTopologySharedPtr _topology;
     HdTopology::ID _topologyId;
+    HdDirtyBits _customDirtyBitsInUse;
     int _refineLevel;  // XXX: could be moved into HdBasisCurveTopology.
     bool _displayOpacity : 1;
 };

pxr/imaging/hdSt/simpleTextShaderKey.cpp

@@ -1,5 +1,5 @@
 //
-// Copyright 2016 Pixar
+// Copyright 2021 Pixar
 //
 // Licensed under the Apache License, Version 2.0 (the "Apache License")
 // with the following modification; you may not use this file except in
@@ -34,10 +34,16 @@ PXR_NAMESPACE_OPEN_SCOPE
 TF_DEFINE_PRIVATE_TOKENS(
     _tokens,
     ((baseGLSLFX, "text.glslfx"))
+
+    // texture based 
     ((vsTextureText, "VSTextureText"))
     ((psTextureText, "PSTextureText"))
+
+    // shader based
     ((vsShaderText, "VSShaderText"))
     ((psShaderText, "PSShaderText"))
+
+    // point id mixins
     ((pointIdNoneVS, "PointId.Vertex.None"))
     ((pointIdFallbackFS, "PointId.Fragment.Fallback"))
 );