3ds Max C++ API Reference
|
Use this interface to access the sun and sky components of a daylight system created by IDaylightSystemFactory. More...
#include <IDaylightSystem.h>
Public Member Functions | |
virtual LightObject * | GetSun () const =0 |
Returns the sun component of the daylight system. | |
virtual LightObject * | GetSky () const =0 |
Returns the sky component of the daylight system. | |
virtual void | SetPosition (const Point3 &position)=0 |
Sets the position of the compass of the daylight system. | |
virtual Point3 | GetPosition () const =0 |
Returns the position of the compass of the daylight system. | |
virtual void | SetOrbitalScale (float orbScale)=0 |
Sets the orbital scale of the system. | |
virtual float | GetOrbitalScale () const =0 |
Returns the orbital scale of the system. | |
virtual void | SetNorthDirection (float angle)=0 |
Sets the value of the north direction. | |
virtual float | GetNorthDirection () const =0 |
Returns the value of the north direction. | |
virtual void | SetCompassDiameter (float compassDiameter)=0 |
Sets the compass diameter of this daylight. | |
virtual float | GetCompassDiameter () const =0 |
Returns the compass diameter of this daylight system. | |
virtual void | SetTimeOfDay (const Point3 &time)=0 |
Sets the current time associated with this daylight system. | |
virtual Point3 | GetTimeOfDay () const =0 |
Returns the current time associated with this daylight system. | |
virtual void | SetDate (const Point3 &date)=0 |
Sets the current date associated to this daylight system. | |
virtual Point3 | GetDate () const =0 |
Returns the current date associated to this daylight system. | |
virtual void | SetLatLong (float latitude, float longitude)=0 |
Set the latitude and longitude of this daylight system, note that the time zone, city, azimuth and altitude are automatically calculated. | |
virtual float | GetLatitude () const =0 |
Returns latitude value of this daylight system. | |
virtual float | GetLongitude () const =0 |
Longitude value of this daylight system. | |
virtual void | SetDaylightSavingTime (BOOL isDaylightSavingTime)=0 |
Set the daylight saving time parameter. | |
virtual BOOL | GetDaylightSavingTime () const =0 |
Returns the daylight saving time parameter. | |
![]() | |
FPMixinInterface () | |
virtual LifetimeType | LifetimeControl () |
virtual CoreExport bool | RegisterNotifyCallback (InterfaceNotifyCallback *incb) |
virtual void | UnRegisterNotifyCallback (InterfaceNotifyCallback *incb) |
CoreExport | ~FPMixinInterface () |
virtual BaseInterface * | GetInterface (Interface_ID id) |
virtual FPInterfaceDesc * | GetDescByID (Interface_ID id) |
virtual Interface_ID | GetID () |
![]() | |
virtual BaseInterface * | GetInterface (Interface_ID id) |
virtual FPInterfaceDesc * | GetDesc ()=0 |
virtual CoreExport FPStatus | Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL) |
virtual FPStatus | Invoke (FunctionID fid, FPParams *params) |
virtual CoreExport FPStatus | Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL) |
virtual FPStatus | Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL) |
virtual CoreExport FunctionID | FindFn (const MCHAR *name) |
virtual CoreExport BOOL | IsEnabled (FunctionID actionID) |
virtual CoreExport BOOL | IsChecked (FunctionID actionID) |
virtual CoreExport BOOL | IsVisible (FunctionID actionID) |
virtual CoreExport FunctionID | GetIsEnabled (FunctionID actionID) |
virtual CoreExport FunctionID | GetIsChecked (FunctionID actionID) |
virtual CoreExport FunctionID | GetIsVisible (FunctionID actionID) |
virtual ActionTable * | GetActionTable () |
virtual void | EnableActions (BOOL onOff) |
![]() | |
virtual UtilExport | ~BaseInterface () |
Destructor. | |
UtilExport BaseInterface * | GetInterface (Interface_ID id) override |
virtual UtilExport Interface_ID | GetID () |
virtual LifetimeType | LifetimeControl () |
virtual bool | RegisterNotifyCallback (InterfaceNotifyCallback *incb) |
virtual void | UnRegisterNotifyCallback (InterfaceNotifyCallback *incb) |
virtual BaseInterface * | AcquireInterface () |
virtual void | ReleaseInterface () |
virtual void | DeleteInterface () |
virtual BaseInterface * | CloneInterface (void *remapDir=nullptr) |
![]() | |
virtual UtilExport | ~InterfaceServer () |
Destructor. | |
virtual UtilExport BaseInterface * | GetInterface (Interface_ID id) |
template<class InterfaceType > | |
InterfaceType * | GetTypedInterface () |
Additional Inherited Members | |
![]() | |
enum | LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled } |
![]() | |
static UtilExport void * | operator new (size_t size) |
Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, const std::nothrow_t &e) |
Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new (size_t size, const char *filename, int line) |
New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, int block_type, const char *filename, int line) |
New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, const char *filename, int line) |
New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new (size_t size, unsigned long flags) |
New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, unsigned long flags) |
New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new[] (size_t size) |
New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e) |
New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new[] (size_t size, const char *filename, int line) |
New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new[] (size_t size, int block_type, const char *filename, int line) |
New operator used to allocate arrays of objects. | |
static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line) |
New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new[] (size_t size, unsigned long flags) |
New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags) |
New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. | |
static UtilExport void | operator delete (void *ptr) |
Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e) |
Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete (void *ptr, const char *filename, int line) |
Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete (void *ptr, int block_type, const char *filename, int line) |
Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete (void *ptr, unsigned long flags) |
Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags) |
Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete[] (void *ptr) |
Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e) |
Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete[] (void *ptr, const char *filename, int line) |
Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete[] (void *ptr, int block_type, const char *filename, int line) |
Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete[] (void *ptr, unsigned long flags) |
Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags) |
Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, void *placement_ptr) |
Placement new operator. | |
static UtilExport void | operator delete (void *ptr, void *placement_ptr) |
Placement delete operator. | |
static UtilExport void * | aligned_malloc (size_t size, size_t alignment) |
Allocates memory on a specified alignment boundary. | |
static UtilExport void * | aligned_realloc (void *ptr, size_t size, size_t alignment) |
Reallocates memory on a specified alignment boundary. | |
static UtilExport void | aligned_free (void *ptr) |
Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. | |
![]() | |
static CoreExport FPInterfaceDesc | nullInterface |
![]() | |
FPMixinInterface (const FPMixinInterface &rhs) | |
FPMixinInterface & | operator= (const FPMixinInterface &rhs) |
![]() | |
virtual FPStatus | _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p) |
![]() | |
Tab< InterfaceNotifyCallback * > * | interfaceNotifyCBs |
Use this interface to access the sun and sky components of a daylight system created by IDaylightSystemFactory.
This interface can be obtained when the daylight system is created. See IDaylightSystemFactory::Create In the case of an already existent daylight system, this interface can be obtained from the base object of the daylight assembly:
|
pure virtual |
Returns the sun component of the daylight system.
It can be directional light, IES sun or MR sun depending on the market defaults.
|
pure virtual |
Returns the sky component of the daylight system.
It can be standard sky, IES sky or MR sky depending on the market defaults.
|
pure virtual |
Sets the position of the compass of the daylight system.
[in] | position | Origin position of the system |
|
pure virtual |
Returns the position of the compass of the daylight system.
|
pure virtual |
Sets the orbital scale of the system.
[in] | orbScale | distance of the sun (the directional light) from the compass rose (orbital scale in the UI) Note that the orbital scale does not have an effect on the sun's precision or how it's rendered. |
|
pure virtual |
Returns the orbital scale of the system.
|
pure virtual |
Sets the value of the north direction.
[in] | angle | rotational direction of the compass rose in the scene (north direction in the UI) The angle is in degree. The value is expected to be >=0. |
|
pure virtual |
Returns the value of the north direction.
|
pure virtual |
Sets the compass diameter of this daylight.
[in] | compassDiameter | this parameter controls the diameter of the compass rose. Note that the compass diameter does not have an effect on the sun's precision or how it's rendered. The value is expected to be >=0. |
|
pure virtual |
Returns the compass diameter of this daylight system.
Note that the compass diameter does not have an effect on the sun's precision or how it's rendered.
|
pure virtual |
Sets the current time associated with this daylight system.
[in] | time | time of day. The expected format is : (hour,minute,second) |
|
pure virtual |
Returns the current time associated with this daylight system.
|
pure virtual |
Sets the current date associated to this daylight system.
[in] | date | date of the year. The expected format is : (month,day,year) |
|
pure virtual |
Returns the current date associated to this daylight system.
|
pure virtual |
Set the latitude and longitude of this daylight system, note that the time zone, city, azimuth and altitude are automatically calculated.
[in] | latitude | latitude of the location (used to determine city) |
[in] | longitude | longitude of the location (used to determine city) |
|
pure virtual |
Returns latitude value of this daylight system.
|
pure virtual |
Longitude value of this daylight system.
|
pure virtual |
Set the daylight saving time parameter.
[in] | isDaylightSavingTime | When on, calculates daylight savings by adjusting azimuth and altitude during the summer months. |
|
pure virtual |
Returns the daylight saving time parameter.