XSI::Null

Null Class Reference

Related Scripting Object: Null | Supported Parameter List: null

The Null object is a specialized X3DObject object and represents a point in space with no dimensions. Nulls can be used to set constraints, organize objects into hierarchies, and so on. More...

#include <xsi_null.h>

Inheritance diagram for Null:

X3DObject SceneItem ProjectItem SIObject CBase Rig CameraRig LightRig List of all members.

Public Member Functions
  Null ()
  ~Null ()
  Null (const CRef &in_ref)
  Null (const Null &in_obj)
bool  IsA (siClassID in_ClassID) const
siClassID  GetClassID () const
Null &  operator= (const Null &in_obj)
Null &  operator= (const CRef &in_ref)

Detailed Description

The Null object is a specialized X3DObject object and represents a point in space with no dimensions. Nulls can be used to set constraints, organize objects into hierarchies, and so on.

See also:
Light
Example: 
        using namespace XSI;
        Application app;
        Model root = app.GetActiveSceneRoot();

        Null myNull;
        root.AddNull( L"MyNull", myNull );

        app.LogMessage( myNull.GetFullName() );

Constructor & Destructor Documentation

Null (  ) 

Default constructor.

~Null (  ) 

Default destructor.

Null ( const CRef &  in_ref  ) 

Constructor.

Parameters:
in_ref  constant reference object.

Null ( const Null &  in_obj  ) 

Copy constructor.

Parameters:
in_obj  constant class object.

Member Function Documentation

bool IsA ( siClassID  in_ClassID  )  const [virtual]

Returns true if a given class type is compatible with this API class.

Parameters:
in_ClassID  class type.
Returns:
true if the class is compatible, false otherwise.

Reimplemented from X3DObject.

Reimplemented in CameraRig, LightRig, and Rig.

siClassID GetClassID (  )  const [virtual]

Returns the type of the API class.

Returns:
The class type.

Reimplemented from X3DObject.

Reimplemented in CameraRig, LightRig, and Rig.

Null& operator= ( const Null &  in_obj  ) 

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

Parameters:
in_obj  constant class object.
Returns:
The new Null object.

Null& operator= ( const CRef &  in_ref  ) 

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

Parameters:
in_ref  constant class object.
Returns:
The new Null object.

Reimplemented from X3DObject.

Reimplemented in CameraRig, LightRig, and Rig.

The documentation for this class was generated from the following file: