diff options
Diffstat (limited to 'source/blender/compositor/intern/COM_SocketConnection.h')
| -rw-r--r-- | source/blender/compositor/intern/COM_SocketConnection.h | 102 |
1 files changed, 51 insertions, 51 deletions
diff --git a/source/blender/compositor/intern/COM_SocketConnection.h b/source/blender/compositor/intern/COM_SocketConnection.h index 1c4dcebfe07..5385c5be49b 100644 --- a/source/blender/compositor/intern/COM_SocketConnection.h +++ b/source/blender/compositor/intern/COM_SocketConnection.h @@ -29,94 +29,94 @@ #include "COM_ChannelInfo.h" /** - * @brief An SocketConnection is an connection between an InputSocket and an OutputSocket. - * - * <pre> - * +----------+ To InputSocket +----------+ - * | From | SocketConnection \| To Node | - * | Node *====================* | - * | |\ | | - * | | From OutputSocket +----------+ - * +----------+ - * </pre> - * @ingroup Model - * @see InputSocket - * @see OutputSocket - */ + * @brief An SocketConnection is an connection between an InputSocket and an OutputSocket. + * + * <pre> + * +----------+ To InputSocket +----------+ + * | From | SocketConnection \| To Node | + * | Node *====================* | + * | |\ | | + * | | From OutputSocket +----------+ + * +----------+ + * </pre> + * @ingroup Model + * @see InputSocket + * @see OutputSocket + */ class SocketConnection { private: /** - * @brief Startpoint of the connection - */ + * @brief Startpoint of the connection + */ OutputSocket *fromSocket; /** - * @brief Endpoint of the connection - */ + * @brief Endpoint of the connection + */ InputSocket *toSocket; /** - * @brief has the resize already been done for this connection - */ + * @brief has the resize already been done for this connection + */ bool ignoreResizeCheck; public: SocketConnection(); /** - * @brief set the startpoint of the connection - * @param fromsocket - */ + * @brief set the startpoint of the connection + * @param fromsocket + */ void setFromSocket(OutputSocket *fromsocket); /** - * @brief get the startpoint of the connection - * @return from OutputSocket - */ + * @brief get the startpoint of the connection + * @return from OutputSocket + */ OutputSocket *getFromSocket() const; /** - * @brief set the endpoint of the connection - * @param tosocket - */ + * @brief set the endpoint of the connection + * @param tosocket + */ void setToSocket(InputSocket *tosocket); /** - * @brief get the endpoint of the connection - * @return to InputSocket - */ + * @brief get the endpoint of the connection + * @return to InputSocket + */ InputSocket *getToSocket() const; /** - * @brief check if this connection is valid - */ + * @brief check if this connection is valid + */ bool isValid() const; /** - * @brief return the Node where this connection is connected from - */ - NodeBase * getFromNode() const; + * @brief return the Node where this connection is connected from + */ + NodeBase *getFromNode() const; /** - * @brief return the Node where this connection is connected to - */ - NodeBase * getToNode() const; + * @brief return the Node where this connection is connected to + */ + NodeBase *getToNode() const; /** - * @brief set, whether the resize has already been done for this SocketConnection - */ - void setIgnoreResizeCheck(bool check) {this->ignoreResizeCheck = check;} + * @brief set, whether the resize has already been done for this SocketConnection + */ + void setIgnoreResizeCheck(bool check) { this->ignoreResizeCheck = check; } /** - * @brief has the resize already been done for this SocketConnection - */ - bool isIgnoreResizeCheck() const { return this->ignoreResizeCheck;} + * @brief has the resize already been done for this SocketConnection + */ + bool isIgnoreResizeCheck() const { return this->ignoreResizeCheck; } /** - * @brief does this SocketConnection need resolution conversion - * @note PreviewOperation's will be ignored - * @note Already converted SocketConnection's will be ignored - * @return needs conversion [true:false] - */ + * @brief does this SocketConnection need resolution conversion + * @note PreviewOperation's will be ignored + * @note Already converted SocketConnection's will be ignored + * @return needs conversion [true:false] + */ bool needsResolutionConversion() const; }; |