Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions

MayaApi Class Reference

This class presents a wrapper around the global Maya interface. More...

#include "mayaApi.h"

Inheritance diagram for MayaApi:
ReferenceCount MemoryBase

List of all members.

Public Member Functions

bool clear ()
 Resets the global model space to the empty state, for instance in preparation for building a new file.
CoordinateSystem get_coordinate_system ()
 Returns Maya's internal coordinate system in effect.
int get_ref_count () const
 Returns the current reference count.
DistanceUnit get_units ()
 Returns Maya's internal units in effect.
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object.
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
bool is_valid () const
 Returns true if the API has been successfully opened and may be used, or false if there is some problem.
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete[] (void *ptr)
void operator delete[] (void *, void *)
void * operator new (size_t size)
void * operator new (size_t size, void *ptr)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
bool read (const Filename &filename)
 Reads the indicated maya file into the global model space.
void ref () const
 Explicitly increments the reference count.
void set_units (DistanceUnit unit)
 Set Maya's UI units.
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
virtual bool unref () const
 Explicitly decrements the reference count.
void weak_ref (WeakPointerToVoid *ptv)
 Adds the indicated PointerToVoid as a weak reference to this object.
void weak_unref (WeakPointerToVoid *ptv)
 Removes the indicated PointerToVoid as a weak reference to this object.
bool write (const Filename &filename)
 Writes the global model space to the indicated file.

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()
static PT (MayaApi) open_api(string program_name

Public Attributes

static bool bool revertdir = true)
static bool view_license = false

Protected Member Functions

 MayaApi (const string &program_name, bool view_license=false, bool revertdir=true)
 Don't attempt to create this object directly; instead, use the open_api() method.
 MayaApi (const MayaApi &copy)
 Don't attempt to copy MayaApi objects.
bool do_test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool do_test_ref_count_nonzero () const
 Returns true if the reference count is nonzero, false otherwise.
void operator= (const MayaApi &copy)
 Don't attempt to copy MayaApi objects.

Detailed Description

This class presents a wrapper around the global Maya interface.

While the reference count is held, it keeps the Maya interface open, and closes the interface when the object destructs.

Definition at line 33 of file mayaApi.h.


Constructor & Destructor Documentation

MayaApi::MayaApi ( const string &  program_name,
bool  view_license = false,
bool  revertdir = true 
) [protected]

Don't attempt to create this object directly; instead, use the open_api() method.

Definition at line 47 of file mayaApi.cxx.

References ExecutionEnvironment::get_cwd(), and Thread::sleep().

MayaApi::MayaApi ( const MayaApi copy) [protected]

Don't attempt to copy MayaApi objects.

There should be only one of these in the world at a time.

Definition at line 110 of file mayaApi.cxx.


Member Function Documentation

bool MayaApi::clear ( void  )

Resets the global model space to the empty state, for instance in preparation for building a new file.

Returns true if successful, false otherwise.

Definition at line 356 of file mayaApi.cxx.

bool ReferenceCount::do_test_ref_count_integrity ( ) const [protected, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

Definition at line 29 of file referenceCount.cxx.

Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().

bool ReferenceCount::do_test_ref_count_nonzero ( ) const [protected, inherited]

Returns true if the reference count is nonzero, false otherwise.

Definition at line 56 of file referenceCount.cxx.

References ReferenceCount::do_test_ref_count_integrity().

Referenced by ReferenceCount::test_ref_count_nonzero().

CoordinateSystem MayaApi::get_coordinate_system ( )

Returns Maya's internal coordinate system in effect.

Definition at line 439 of file mayaApi.cxx.

int ReferenceCount::get_ref_count ( ) const [inline, inherited]
DistanceUnit MayaApi::get_units ( )

Returns Maya's internal units in effect.

Definition at line 371 of file mayaApi.cxx.

WeakReferenceList * ReferenceCount::get_weak_list ( ) const [inline, inherited]

Returns the WeakReferenceList associated with this ReferenceCount object.

If there has never been a WeakReferenceList associated with this object, creates one now.

Definition at line 307 of file referenceCount.I.

Referenced by ReferenceCount::weak_ref().

bool ReferenceCount::has_weak_list ( ) const [inline, inherited]

Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.

In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).

Definition at line 294 of file referenceCount.I.

Referenced by ReferenceCount::weak_unref().

bool MayaApi::is_valid ( ) const

Returns true if the API has been successfully opened and may be used, or false if there is some problem.

Definition at line 239 of file mayaApi.cxx.

void ReferenceCount::local_object ( ) [inline, inherited]

This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.

This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.

Definition at line 276 of file referenceCount.I.

Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().

void MayaApi::operator= ( const MayaApi copy) [protected]

Don't attempt to copy MayaApi objects.

There should be only one of these in the world at a time.

Definition at line 121 of file mayaApi.cxx.

bool MayaApi::read ( const Filename filename)

Reads the indicated maya file into the global model space.

Returns true if successful, false otherwise.

Definition at line 265 of file mayaApi.cxx.

void ReferenceCount::ref ( ) const [inline, inherited]

Explicitly increments the reference count.

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

Definition at line 179 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().

void MayaApi::set_units ( DistanceUnit  unit)

Set Maya's UI units.

Definition at line 401 of file mayaApi.cxx.

bool ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]
bool ReferenceCount::test_ref_count_nonzero ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

Definition at line 252 of file referenceCount.I.

References ReferenceCount::do_test_ref_count_nonzero().

Referenced by CopyOnWritePointer::test_ref_count_nonzero().

bool ReferenceCount::unref ( ) const [inline, virtual, inherited]

Explicitly decrements the reference count.

Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.

Definition at line 214 of file referenceCount.I.

References ReferenceCount::test_ref_count_integrity().

Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().

void ReferenceCount::weak_ref ( WeakPointerToVoid ptv) [inline, inherited]

Adds the indicated PointerToVoid as a weak reference to this object.

Definition at line 321 of file referenceCount.I.

References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().

void ReferenceCount::weak_unref ( WeakPointerToVoid ptv) [inline, inherited]

Removes the indicated PointerToVoid as a weak reference to this object.

It must have previously been added via a call to weak_ref().

Definition at line 334 of file referenceCount.I.

References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().

bool MayaApi::write ( const Filename filename)

Writes the global model space to the indicated file.

Returns true if successful, false otherwise.

Definition at line 310 of file mayaApi.cxx.

References Filename::get_extension().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations