class SceneObject

in global :: Sandbox

A model scene object that can be rendered within a .

public SceneWorld World { get; }

The scene world this object belongs to.

public Transform Transform { get; set; }

Transform of this scene object, relative to its , or if parent is not set.

public Rotation Rotation { get; set; }

Rotation of this scene object, relative to its , or if parent is not set.

public Vector3 Position { get; set; }

Position of this scene object, relative to its , or if parent is not set.

public BBox Bounds { get; set; }

Set or get the axis aligned bounding box for this object.

public BBox LocalBounds { get; set; }

The world bounds translated to the local position. Note that this does NOT do any scaling or rotation.

public bool RenderingEnabled { get; set; }

Whether this scene object should render or not.

public Color ColorTint { get; set; }

Color tint of this scene object.

public Plane ClipPlane

Clipping plane for this scene object. Requires to be true.

public bool ClipPlaneEnabled

Whether or not to use the clipping plane defined in .

public SceneObject Parent { get; }

Movement parent of this scene object, if any.

public void AddChild( string name, SceneObject child )

Add a named child scene object to this one. The child scene object will have its parent set.

Remarks: The name can be used to look up children by name, but it is not bound. (SceneObject_FindChild)

public void RemoveChild( SceneObject child )

Unlink given scene object as a child from this one. The child scene object will have its parent set to null. It will not be deleted.

public Model Model { get; set; }

The model this scene object will render.

public ulong MeshGroupMask { get; set; }

State of all bodygroups of this object's model. You might be looking for .

public void SetMaterialOverride( Material material )

Override all materials on this object's .

public void SetMaterialOverride( Material material, string attributeName, int attributeValue = 1 )

Replaces all materials of the model that have the given User Material Attribute set to "1", with given material. The system checks both the models' default material group materials and the materials of the active material group.

  • material Material to replace with.
  • attributeName Name of the User Material Attribute to test on each material of the model. They are set in the Material Editor's Attributes tab.
  • attributeValue Value of the attribute to test for.

public void SetMaterialGroup( string name )

Set material group to replace materials of the model as set up in ModelDoc.

public bool Batchable { get; set; }

This object is not batchable by material for some reason ( example: has dynamic attributes that affect rendering )

public SceneObject.SceneObjectFlagAccessor Flags { get; }

Access to various advanced scene object flags.

public SceneRenderLayer RenderLayer { get; set; }

For a layer to draw this object, the target layer must match (or be unset) and the flags must match

public ITagSet Tags { get; }

List of tags for this scene object.

public SceneObject( SceneWorld sceneWorld, string modelName )

😔 No documentation found.

public SceneObject( SceneWorld sceneWorld, string modelName, Transform transform )

😔 No documentation found.

public SceneObject( SceneWorld sceneWorld, Model model, Transform transform )

😔 No documentation found.

public SceneObject( SceneWorld sceneWorld, Model model )

😔 No documentation found.

public void ClearMaterialOverride( )

😔 No documentation found.

public Type GetType( )

😔 No documentation found.

public bool Equals( object obj )

😔 No documentation found.

public int GetHashCode( )

😔 No documentation found.

public void Delete( )

😔 No documentation found.

public string ToString( )

😔 No documentation found.

public RenderAttributes Attributes { get; }

😔 No documentation found.