Skip to content

Commit

Permalink
Inspector : Reposition fallbackValue and improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
murraystevenson committed Jul 25, 2024
1 parent 632bfc4 commit de9ac47
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions include/GafferSceneUI/Private/Inspector.h
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,12 @@ class GAFFERSCENEUI_API Inspector : public IECore::RefCounted, public Gaffer::Si
/// base class?
virtual IECore::ConstObjectPtr value( const GafferScene::SceneAlgo::History *history ) const = 0;

/// Can be implemented by derived classes to provide a fallback value for the inspection,
/// used when no value is returned from `value()`. Called with `history->context` as the current
/// context. Optionally, `description` may be assigned a description to be shown to the user.
/// Typically, this description would be used to disambiguate the source of the fallback value.
virtual IECore::ConstObjectPtr fallbackValue( const GafferScene::SceneAlgo::History *history, std::string &description ) const;

/// Should be implemented by derived classes to return the source for
/// the value authored at this point in the history. Optionally,
/// `editWarning` may be assigned a warning that will be shown to the
Expand All @@ -177,12 +183,6 @@ class GAFFERSCENEUI_API Inspector : public IECore::RefCounted, public Gaffer::Si
/// > that edits the processor itself.
virtual EditFunctionOrFailure editFunction( Gaffer::EditScope *editScope, const GafferScene::SceneAlgo::History *history ) const;

/// Can be implemented by derived classes to provide a fallback value for the inspection,
/// used when no value is returned from `value()`. Optionally, `description` may be
/// assigned a description to be shown to the user. Typically, this description would
/// be used to disambiguate the source of the fallback value.
virtual IECore::ConstObjectPtr fallbackValue( const GafferScene::SceneAlgo::History *history, std::string &description ) const;

protected :

Gaffer::EditScope *targetEditScope() const;
Expand Down

0 comments on commit de9ac47

Please sign in to comment.