vtkMRMLFolderDisplayNode.h

Go to the documentation of this file.

/*==============================================================================

  Program: 3D Slicer

  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. All Rights Reserved.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Csaba Pinter, PerkLab, Queen's University
  and was supported through CANARIE.

==============================================================================*/

#ifndef __vtkMRMLFolderDisplayNode_h
#define __vtkMRMLFolderDisplayNode_h

// MRML includes
#include "vtkMRMLDisplayNode.h"

class vtkMRMLDisplayableNode;

class VTK_MRML_EXPORT vtkMRMLFolderDisplayNode : public vtkMRMLDisplayNode
{
public:
  static vtkMRMLFolderDisplayNode *New();
  vtkTypeMacro(vtkMRMLFolderDisplayNode,vtkMRMLDisplayNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMRMLNode* CreateNodeInstance() override;

  const char* GetNodeTagName() override {return "FolderDisplay";}

  void ReadXMLAttributes(const char** atts) override;

  void WriteXML(ostream& of, int indent) override;

  vtkMRMLCopyContentMacro(vtkMRMLFolderDisplayNode);

  void SetScene(vtkMRMLScene* scene) override;

  void ProcessMRMLEvents( vtkObject *caller, unsigned long event, void *callData) override;

  void Modified() override;

  void SetApplyDisplayPropertiesOnBranch(bool on);
  vtkGetMacro(ApplyDisplayPropertiesOnBranch, bool);

  void ChildDisplayNodesModified();

  static vtkMRMLDisplayNode* GetOverridingHierarchyDisplayNode(vtkMRMLDisplayableNode* node);

  static bool GetHierarchyVisibility(vtkMRMLDisplayableNode* node);

  // or not. Opacity defined by hierarchy is the product of the ancestors' opacities.
  static double GetHierarchyOpacity(vtkMRMLDisplayableNode* node);

protected:
  vtkMRMLFolderDisplayNode();
  ~vtkMRMLFolderDisplayNode() override;
  vtkMRMLFolderDisplayNode(const vtkMRMLFolderDisplayNode&);
  void operator=(const vtkMRMLFolderDisplayNode&);

private:
  bool ApplyDisplayPropertiesOnBranch{false};
};

#endif