This file is indexed.

/usr/include/crystalspace-2.0/iengine/scenenode.h is in libcrystalspace-dev 2.0+dfsg-1build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/*
    Copyright (C) 2005 by Jorrit Tyberghein

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_IENGINE_SCENENODE_H__
#define __CS_IENGINE_SCENENODE_H__

/**\file
 * SceneNode - a node in the scene (linked with movables).
 */
/**
 * \addtogroup engine3d
 * @{ */
 
#include "csutil/scf.h"
#include "csutil/refarr.h"

#include "iutil/array.h"

struct iMovable;
struct iLight;
struct iMeshWrapper;
struct iCamera;

struct iSceneNode;

/**
 * An array of scene node interfaces.
 */
struct iSceneNodeArray : public iArrayReadOnly<iSceneNode*>
{
  SCF_IARRAYREADONLY_INTERFACE(iSceneNodeArray);
};

/**
 * This interface represents a node in the scene graph. It basically
 * represents an object, light, or camera. The scene graph is build out
 * of scene nodes and movables.
 * 
 * When you attach a scene node to another, then the relative position
 * of the two nodes will be kept constant. So, when you move a parent
 * node then the position of the children will be updated automatically.
 * If the parent node is added or removed from a sector then the children
 * will be updated consequently too.
 * 
 * Once attached to a parent node, the transform of the iMovable of the
 * node will be interpreted as the relative position bewteen the child and
 * its parent.
 * 
 * Main ways to get pointers to this interface:
 * - iMeshWrapper::QuerySceneNode()
 * - iLight::QuerySceneNode()
 * - iCamera::QuerySceneNode()
 * - iMovable::GetSceneNode()
 * 
 * Main users of this interface:
 * - iEngine
 */
struct iSceneNode : public virtual iBase
{
  SCF_INTERFACE(iSceneNode, 2,0,1);

  /**
   * Get the movable for this scene node. The transform of the movable is
   * defined in world coordinates if this node has not parent. Otherwise,
   * the transform is defined relative to the parent node.
   */
  virtual iMovable* GetMovable () const = 0;

  /**
   * Get the corresponding mesh. Returns 0 if this is not a node for a mesh.
   */
  virtual iMeshWrapper* QueryMesh () = 0;

  /**
   * Get the corresponding light. Returns 0 if this is not a node for a light.
   */
  virtual iLight* QueryLight () = 0;

  /**
   * Get the corresponding camera. Returns 0 if this is not a node for a camera.
   */
  virtual iCamera* QueryCamera () = 0;

  /**
   * Set the parent scene node.
   */
  virtual void SetParent (iSceneNode* parent) = 0;

  /**
   * Get the parent scene node.
   */
  virtual iSceneNode* GetParent () const = 0;

  /**
   * The children of this scene node.
   */
  CS_DEPRECATED_METHOD_MSG("Use csPtr<iSceneNodeArray> GetChildrenArray() const")
  virtual const csRefArray<iSceneNode>& GetChildren () const = 0;

  /**
   * The children of this scene node.
   */
  virtual csPtr<iSceneNodeArray> GetChildrenArray () const = 0;
};

/** @} */

#endif // __CS_IENGINE_SCENENODE_H__