Skip to content

Commit c5d6c1a

Browse files
cozdasdoug-walker
cozdas
and
doug-walker
authored
Adsk Contrib - Renaming the view helper functions to follow the OCIO conventions. (#2167)
* Renaming the newly added view helper functions to follow the OCIO conventions. - The wording order {object(s)}{Is|Are|Has|Have}{State} for the newly added function names are different than the more typical convention of {is|are|have|has}{Object(s)}{State}. - Config class already has functions in the second form, such as Config::isColorSpaceUsed() or Config::isColorSpaceLinear(). We also have functions named in yet another form like Config::isInactiveColorSpace(). So not to introduce a 3rd variant, I'm renaming these newly added ones. Signed-off-by: cuneyt.ozdas <cuneyt.ozdas@autodesk.com> * capitalizing two function names per request. Signed-off-by: cuneyt.ozdas <cuneyt.ozdas@autodesk.com> --------- Signed-off-by: cuneyt.ozdas <cuneyt.ozdas@autodesk.com> Co-authored-by: Doug Walker <doug.walker@autodesk.com>
1 parent db68839 commit c5d6c1a

File tree

6 files changed

+128
-128
lines changed

6 files changed

+128
-128
lines changed

‎include/OpenColorIO/OpenColorIO.h‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -854,7 +854,7 @@ class OCIOEXPORT Config
854854
*/
855855

856856
/// Check if a view within a given display is referencing one of the config's shared views.
857-
bool viewIsShared(const char * dispName, const char * viewName) const;
857+
bool isViewShared(const char * dispName, const char * viewName) const;
858858

859859
/// Will throw if view or colorSpaceName are null or empty.
860860
void addSharedView(const char * view, const char * viewTransformName,
@@ -902,7 +902,7 @@ class OCIOEXPORT Config
902902
* the function does not attempt to compare that the color spaces or view transforms
903903
* being referenced are identical (only that they have the same name).
904904
*/
905-
static bool ViewsAreEqual(const ConstConfigRcPtr & first,
905+
static bool AreViewsEqual(const ConstConfigRcPtr & first,
906906
const ConstConfigRcPtr & second,
907907
const char * dispName,
908908
const char * viewName);
@@ -933,7 +933,7 @@ class OCIOEXPORT Config
933933
* check config-level shared views if dispName is null. It will not check config level
934934
* shared views if dispName is not null.
935935
*/
936-
bool displayHasView(const char * dispName, const char * viewName) const;
936+
bool hasView(const char * dispName, const char * viewName) const;
937937

938938
/**
939939
* For the (display, view) pair, specify which color space and look to use.
@@ -1008,7 +1008,7 @@ class OCIOEXPORT Config
10081008
bool hasVirtualView(const char * viewName) const;
10091009

10101010
/// Check if a given virtual view is referencing one of the config's shared views.
1011-
bool virtualViewIsShared(const char * viewName) const;
1011+
bool isVirtualViewShared(const char * viewName) const;
10121012

10131013
void addVirtualDisplayView(const char * view,
10141014
const char * viewTransformName,
@@ -1037,7 +1037,7 @@ class OCIOEXPORT Config
10371037
* the function does not attempt to compare that the color spaces or view transforms
10381038
* being referenced are identical (only that they have the same name).
10391039
*/
1040-
static bool VirtualViewsAreEqual(const ConstConfigRcPtr & first,
1040+
static bool AreVirtualViewsEqual(const ConstConfigRcPtr & first,
10411041
const ConstConfigRcPtr & second,
10421042
const char * viewName);
10431043

‎src/OpenColorIO/Config.cpp‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3305,7 +3305,7 @@ void Config::setViewingRules(ConstViewingRulesRcPtr viewingRules)
33053305
getImpl()->resetCacheIDs();
33063306
}
33073307

3308-
bool Config::viewIsShared(const char * dispName, const char * viewName) const
3308+
bool Config::isViewShared(const char * dispName, const char * viewName) const
33093309
{
33103310
if (!viewName || !*viewName) return false;
33113311

@@ -3517,7 +3517,7 @@ const char * Config::getView(const char * display, const char * colorspace, int
35173517
}
35183518

35193519

3520-
bool Config::ViewsAreEqual(const ConstConfigRcPtr & first,
3520+
bool Config::AreViewsEqual(const ConstConfigRcPtr & first,
35213521
const ConstConfigRcPtr & second,
35223522
const char * dispName, // may be empty or nullptr for shared views
35233523
const char * viewName)
@@ -3591,7 +3591,7 @@ const char * Config::getDisplayViewDescription(const char * display, const char
35913591
return viewPtr ? viewPtr->m_description.c_str() : "";
35923592
}
35933593

3594-
bool Config::displayHasView(const char * dispName, const char * viewName) const
3594+
bool Config::hasView(const char * dispName, const char * viewName) const
35953595
{
35963596
// This returns null if either the display or view doesn't exist.
35973597
// It works regardless of whether the display or view are active,
@@ -3784,7 +3784,7 @@ bool Config::hasVirtualView(const char * viewName) const
37843784
return (cs && *cs);
37853785
}
37863786

3787-
bool Config::virtualViewIsShared(const char * viewName) const
3787+
bool Config::isVirtualViewShared(const char * viewName) const
37883788
{
37893789
if (!viewName || !*viewName) return false;
37903790

@@ -3900,7 +3900,7 @@ const char * Config::getVirtualDisplayView(ViewType type, int index) const noexc
39003900
return "";
39013901
}
39023902

3903-
bool Config::VirtualViewsAreEqual(const ConstConfigRcPtr & first,
3903+
bool Config::AreVirtualViewsEqual(const ConstConfigRcPtr & first,
39043904
const ConstConfigRcPtr & second,
39053905
const char * viewName)
39063906
{
@@ -3933,7 +3933,7 @@ const char * Config::getVirtualDisplayViewTransformName(const char * view) const
39333933
if (!view) return "";
39343934

39353935
// Get the view transform name for the case where a virtual view is shared.
3936-
if (virtualViewIsShared(view))
3936+
if (isVirtualViewShared(view))
39373937
{
39383938
return getDisplayViewTransformName(nullptr, view);
39393939
}
@@ -3952,7 +3952,7 @@ const char * Config::getVirtualDisplayViewColorSpaceName(const char * view) cons
39523952
if (!view) return "";
39533953

39543954
// Get the colorspace name for the case where a virtual view is shared.
3955-
if (virtualViewIsShared(view))
3955+
if (isVirtualViewShared(view))
39563956
{
39573957
return getDisplayViewColorSpaceName(nullptr, view);
39583958
}
@@ -3971,7 +3971,7 @@ const char * Config::getVirtualDisplayViewLooks(const char * view) const noexcep
39713971
if (!view) return "";
39723972

39733973
// Get the view looks for the case where a virtual view is shared
3974-
if (virtualViewIsShared(view))
3974+
if (isVirtualViewShared(view))
39753975
{
39763976
return getDisplayViewLooks(nullptr, view);
39773977
}
@@ -3990,7 +3990,7 @@ const char * Config::getVirtualDisplayViewRule(const char * view) const noexcept
39903990
if (!view) return "";
39913991

39923992
// Get the view rule for the case where a virtual view is shared
3993-
if (virtualViewIsShared(view))
3993+
if (isVirtualViewShared(view))
39943994
{
39953995
return getDisplayViewRule(nullptr, view);
39963996
}
@@ -4009,7 +4009,7 @@ const char * Config::getVirtualDisplayViewDescription(const char * view) const n
40094009
if (!view) return "";
40104010

40114011
// Get the view description for the case where a virtual view is shared
4012-
if (virtualViewIsShared(view))
4012+
if (isVirtualViewShared(view))
40134013
{
40144014
return getDisplayViewDescription(nullptr, view);
40154015
}

‎src/bindings/python/PyConfig.cpp‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -458,9 +458,9 @@ void bindPyConfig(py::module & m)
458458
.def("getDisplayViewDescription", &Config::getDisplayViewDescription,
459459
"display"_a, "view"_a,
460460
DOC(Config, getDisplayViewDescription))
461-
.def("displayHasView", &Config::displayHasView,
461+
.def("hasView", &Config::hasView,
462462
"display"_a, "view"_a,
463-
DOC(Config, displayHasView))
463+
DOC(Config, hasView))
464464
.def("addDisplayView",
465465
(void (Config::*)(const char *, const char *, const char *, const char *))
466466
&Config::addDisplayView,
@@ -480,23 +480,23 @@ void bindPyConfig(py::module & m)
480480
"ruleName"_a = "",
481481
"description"_a = "",
482482
DOC(Config, addDisplayView))
483-
.def("viewIsShared", &Config::viewIsShared, "display"_a, "view"_a,
484-
DOC(Config, viewIsShared))
483+
.def("isViewShared", &Config::isViewShared, "display"_a, "view"_a,
484+
DOC(Config, isViewShared))
485485
.def("addDisplaySharedView", &Config::addDisplaySharedView, "display"_a, "view"_a,
486486
DOC(Config, addDisplaySharedView))
487487
.def("removeDisplayView", &Config::removeDisplayView, "display"_a, "view"_a,
488488
DOC(Config, removeDisplayView))
489489
.def("clearDisplays", &Config::clearDisplays,
490490
DOC(Config, clearDisplays))
491-
.def_static("ViewsAreEqual", [](const ConstConfigRcPtr & first,
491+
.def_static("AreViewsEqual", [](const ConstConfigRcPtr & first,
492492
const ConstConfigRcPtr & second,
493493
const char * dispName,
494494
const char * viewName)
495495
{
496-
return Config::ViewsAreEqual(first, second, dispName, viewName);
496+
return Config::AreViewsEqual(first, second, dispName, viewName);
497497
},
498498
"first"_a, "second"_a, "dispName"_a, "viewName"_a,
499-
DOC(Config, ViewsAreEqual))
499+
DOC(Config, AreViewsEqual))
500500

501501
// Virtual Display
502502
.def("hasVirtualView", &Config::hasVirtualView, "view"_a,
@@ -507,8 +507,8 @@ void bindPyConfig(py::module & m)
507507
"ruleName"_a = "",
508508
"description"_a = "",
509509
DOC(Config, addVirtualDisplayView))
510-
.def("virtualViewIsShared", &Config::virtualViewIsShared, "view"_a,
511-
DOC(Config, virtualViewIsShared))
510+
.def("isVirtualViewShared", &Config::isVirtualViewShared, "view"_a,
511+
DOC(Config, isVirtualViewShared))
512512
.def("addVirtualDisplaySharedView", &Config::addVirtualDisplaySharedView, "sharedView"_a,
513513
DOC(Config, addVirtualDisplaySharedView))
514514
.def("getVirtualDisplayViews", [](ConfigRcPtr & self, ViewType type)
@@ -552,14 +552,14 @@ void bindPyConfig(py::module & m)
552552
return false;
553553
},
554554
"display"_a)
555-
.def_static("VirtualViewsAreEqual", [](const ConstConfigRcPtr & first,
555+
.def_static("AreVirtualViewsEqual", [](const ConstConfigRcPtr & first,
556556
const ConstConfigRcPtr & second,
557557
const char * viewName)
558558
{
559-
return Config::VirtualViewsAreEqual(first, second, viewName);
559+
return Config::AreVirtualViewsEqual(first, second, viewName);
560560
},
561561
"first"_a, "second"_a, "viewName"_a,
562-
DOC(Config, VirtualViewsAreEqual))
562+
DOC(Config, AreVirtualViewsEqual))
563563

564564
// Active Displays and Views
565565
.def("setActiveDisplays", &Config::setActiveDisplays, "displays"_a,

‎tests/cpu/Config_tests.cpp‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6903,26 +6903,26 @@ OCIO_ADD_TEST(Config, display_view)
69036903
// Add a simple view.
69046904
const std::string display{ "display" };
69056905

6906-
OCIO_CHECK_ASSERT(!config->displayHasView(display.c_str(), "view1"));
6906+
OCIO_CHECK_ASSERT(!config->hasView(display.c_str(), "view1"));
69076907

69086908
OCIO_CHECK_NO_THROW(config->addDisplayView(display.c_str(), "view1", "scs", ""));
69096909

6910-
OCIO_CHECK_ASSERT(config->displayHasView(display.c_str(), "view1"));
6910+
OCIO_CHECK_ASSERT(config->hasView(display.c_str(), "view1"));
69116911

69126912
OCIO_CHECK_NO_THROW(config->validate());
69136913

6914-
OCIO_CHECK_ASSERT(!config->displayHasView(display.c_str(), "view2"));
6914+
OCIO_CHECK_ASSERT(!config->hasView(display.c_str(), "view2"));
69156915

69166916
OCIO_CHECK_NO_THROW(config->addDisplayView(display.c_str(), "view2", "view_transform", "scs",
69176917
"", "", ""));
69186918
OCIO_CHECK_THROW_WHAT(config->validate(), OCIO::Exception,
69196919
"color space, 'scs', that is not a display-referred");
69206920

6921-
OCIO_CHECK_ASSERT(config->displayHasView(display.c_str(), "view2"));
6921+
OCIO_CHECK_ASSERT(config->hasView(display.c_str(), "view2"));
69226922

69236923
OCIO_CHECK_NO_THROW(config->addDisplayView(display.c_str(), "view2", "view_transform", "dcs",
69246924
"", "", ""));
6925-
OCIO_CHECK_ASSERT(config->displayHasView(display.c_str(), "view2"));
6925+
OCIO_CHECK_ASSERT(config->hasView(display.c_str(), "view2"));
69266926

69276927
OCIO_CHECK_NO_THROW(config->validate());
69286928

@@ -7350,7 +7350,7 @@ OCIO_ADD_TEST(Config, add_remove_display)
73507350
// Add a (display, view) pair.
73517351

73527352
OCIO_CHECK_NO_THROW(config->addDisplayView("disp1", "view1", "raw", nullptr));
7353-
OCIO_CHECK_ASSERT(config->displayHasView("disp1", "view1"));
7353+
OCIO_CHECK_ASSERT(config->hasView("disp1", "view1"));
73547354
OCIO_REQUIRE_EQUAL(config->getNumDisplays(), 2);
73557355
OCIO_CHECK_EQUAL(std::string(config->getDisplay(0)), std::string("sRGB"));
73567356
OCIO_CHECK_EQUAL(std::string(config->getDisplay(1)), std::string("disp1"));
@@ -7359,7 +7359,7 @@ OCIO_ADD_TEST(Config, add_remove_display)
73597359
// Remove a (display, view) pair.
73607360

73617361
OCIO_CHECK_NO_THROW(config->removeDisplayView("disp1", "view1"));
7362-
OCIO_CHECK_ASSERT(!config->displayHasView("disp1", "view1"));
7362+
OCIO_CHECK_ASSERT(!config->hasView("disp1", "view1"));
73637363
OCIO_REQUIRE_EQUAL(config->getNumDisplays(), 1);
73647364
OCIO_CHECK_EQUAL(std::string(config->getDisplay(0)), std::string("sRGB"));
73657365
}
@@ -8503,10 +8503,10 @@ active_views: []
85038503
OCIO_CHECK_EQUAL(1, config->getNumViews(OCIO::VIEW_SHARED, "sRGB"));
85048504

85058505
OCIO_CHECK_EQUAL(std::string("sview1"), config->getView(OCIO::VIEW_SHARED, "sRGB", 0));
8506-
OCIO_CHECK_ASSERT(config->displayHasView("sRGB", "sview1"));
8507-
OCIO_CHECK_ASSERT(config->viewIsShared("sRGB", "sview1"));
8508-
OCIO_CHECK_ASSERT(!config->viewIsShared("sRGB", ""));
8509-
OCIO_CHECK_ASSERT(!config->viewIsShared("sRGB", nullptr));
8506+
OCIO_CHECK_ASSERT(config->hasView("sRGB", "sview1"));
8507+
OCIO_CHECK_ASSERT(config->isViewShared("sRGB", "sview1"));
8508+
OCIO_CHECK_ASSERT(!config->isViewShared("sRGB", ""));
8509+
OCIO_CHECK_ASSERT(!config->isViewShared("sRGB", nullptr));
85108510

85118511
OCIO_CHECK_EQUAL(std::string("raw"), config->getDisplayViewColorSpaceName("sRGB", "sview1"));
85128512
OCIO_CHECK_EQUAL(std::string("raw"), config->getVirtualDisplayViewColorSpaceName("sview2"));
@@ -8516,9 +8516,9 @@ active_views: []
85168516
{
85178517
OCIO::ConfigRcPtr cfg = config->createEditableCopy();
85188518

8519-
OCIO_CHECK_ASSERT(OCIO::Config::ViewsAreEqual(config, cfg, "sRGB", "sview1"));
8520-
OCIO_CHECK_ASSERT(OCIO::Config::ViewsAreEqual(config, cfg, "sRGB", "Raw"));
8521-
OCIO_CHECK_ASSERT(OCIO::Config::ViewsAreEqual(config, cfg, "sRGB", "view"));
8519+
OCIO_CHECK_ASSERT(OCIO::Config::AreViewsEqual(config, cfg, "sRGB", "sview1"));
8520+
OCIO_CHECK_ASSERT(OCIO::Config::AreViewsEqual(config, cfg, "sRGB", "Raw"));
8521+
OCIO_CHECK_ASSERT(OCIO::Config::AreViewsEqual(config, cfg, "sRGB", "view"));
85228522

85238523
OCIO_REQUIRE_EQUAL(2, cfg->getVirtualDisplayNumViews(OCIO::VIEW_DISPLAY_DEFINED));
85248524

@@ -8533,7 +8533,7 @@ active_views: []
85338533
OCIO_CHECK_EQUAL(std::string(""), cfg->getVirtualDisplayViewRule(viewName));
85348534
OCIO_CHECK_EQUAL(std::string(""), cfg->getVirtualDisplayViewDescription(viewName));
85358535

8536-
OCIO_CHECK_ASSERT(OCIO::Config::VirtualViewsAreEqual(config, cfg, viewName));
8536+
OCIO_CHECK_ASSERT(OCIO::Config::AreVirtualViewsEqual(config, cfg, viewName));
85378537

85388538
viewName = cfg->getVirtualDisplayView(OCIO::VIEW_DISPLAY_DEFINED, 1);
85398539

@@ -8549,17 +8549,17 @@ active_views: []
85498549
OCIO_CHECK_EQUAL(std::string("raw"), cfg->getVirtualDisplayViewColorSpaceName("sview2"));
85508550

85518551
OCIO_CHECK_ASSERT(cfg->hasVirtualView("sview2"));
8552-
OCIO_CHECK_ASSERT(cfg->virtualViewIsShared("sview2"));
8553-
OCIO_CHECK_ASSERT(OCIO::Config::VirtualViewsAreEqual(config, cfg, "sview2"));
8552+
OCIO_CHECK_ASSERT(cfg->isVirtualViewShared("sview2"));
8553+
OCIO_CHECK_ASSERT(OCIO::Config::AreVirtualViewsEqual(config, cfg, "sview2"));
85548554

8555-
OCIO_CHECK_ASSERT(!cfg->virtualViewIsShared(""));
8556-
OCIO_CHECK_ASSERT(!cfg->virtualViewIsShared(nullptr));
8555+
OCIO_CHECK_ASSERT(!cfg->isVirtualViewShared(""));
8556+
OCIO_CHECK_ASSERT(!cfg->isVirtualViewShared(nullptr));
85578557

85588558
// Remove a view from the Virtual Display.
85598559

85608560
cfg->removeVirtualDisplayView("Raw");
85618561

8562-
OCIO_CHECK_ASSERT(!OCIO::Config::VirtualViewsAreEqual(config, cfg, "Raw"));
8562+
OCIO_CHECK_ASSERT(!OCIO::Config::AreVirtualViewsEqual(config, cfg, "Raw"));
85638563
OCIO_CHECK_ASSERT(!cfg->hasVirtualView("Raw"));
85648564

85658565
OCIO_REQUIRE_EQUAL(1, cfg->getVirtualDisplayNumViews(OCIO::VIEW_DISPLAY_DEFINED));
@@ -8574,8 +8574,8 @@ active_views: []
85748574
OCIO_REQUIRE_EQUAL(1, cfg->getVirtualDisplayNumViews(OCIO::VIEW_DISPLAY_DEFINED));
85758575
OCIO_REQUIRE_EQUAL(0, cfg->getVirtualDisplayNumViews(OCIO::VIEW_SHARED));
85768576
OCIO_CHECK_ASSERT(!cfg->hasVirtualView("sview2"));
8577-
OCIO_CHECK_ASSERT(!cfg->virtualViewIsShared("sview2"));
8578-
OCIO_CHECK_ASSERT(!OCIO::Config::VirtualViewsAreEqual(config, cfg, "sview2"));
8577+
OCIO_CHECK_ASSERT(!cfg->isVirtualViewShared("sview2"));
8578+
OCIO_CHECK_ASSERT(!OCIO::Config::AreVirtualViewsEqual(config, cfg, "sview2"));
85798579

85808580
{
85818581
// Extra serialize & deserialize validation.
@@ -8596,14 +8596,14 @@ active_views: []
85968596
cfg->addVirtualDisplaySharedView("sview2");
85978597
OCIO_REQUIRE_EQUAL(1, cfg->getVirtualDisplayNumViews(OCIO::VIEW_DISPLAY_DEFINED));
85988598
OCIO_REQUIRE_EQUAL(1, cfg->getVirtualDisplayNumViews(OCIO::VIEW_SHARED));
8599-
OCIO_CHECK_ASSERT(cfg->virtualViewIsShared("sview2"));
8599+
OCIO_CHECK_ASSERT(cfg->isVirtualViewShared("sview2"));
86008600

86018601
// Remove the Virtual Display.
86028602

86038603
cfg->clearVirtualDisplay();
86048604
OCIO_REQUIRE_EQUAL(0, cfg->getVirtualDisplayNumViews(OCIO::VIEW_DISPLAY_DEFINED));
86058605
OCIO_REQUIRE_EQUAL(0, cfg->getVirtualDisplayNumViews(OCIO::VIEW_SHARED));
8606-
OCIO_CHECK_ASSERT(!cfg->virtualViewIsShared("sview2"));
8606+
OCIO_CHECK_ASSERT(!cfg->isVirtualViewShared("sview2"));
86078607

86088608
{
86098609
// Extra serialize & deserialize validation.

0 commit comments

Comments
 (0)