#include <opennurbs_light.h>

Inheritance diagram for ON_Light:
ON_Geometry ON_Object

Public Member Functions

 ON_Light ()
 
 ON_Light (const ON_Light &)=default
 
 ~ON_Light ()
 
ON_Color Ambient () const
 
ON_3dVector Attenuation () const
 
double Attenuation (double) const
 
ON::coordinate_system CoordinateSystem () const
 
void Default ()
 
ON_Color Diffuse () const
 
int Dimension () const override
 Dimension of the object. More...
 
ON_3dVector Direction () const
 
void Dump (ON_TextLog &) const override
 Creates a text dump of the object. More...
 
bool Enable (bool=true)
 
bool GetBBox (double *boxmin, double *boxmax, bool bGrowBox=false) const override
 virtual ON_Geometry GetBBox override More...
 
bool GetLightXform (const ON_Viewport &vp, ON::coordinate_system dest_cs, ON_Xform &xform) const
 A light's location and direction can be defined with respect to world, camera, or view coordinates. GetLightXform gets the transformation from the light's intrinsic coordinate system to the destination coordinate system specified by dest_cs. More...
 
bool GetSpotLightRadii (double *inner_radius, double *outer_radius) const
 The spotlight radii are useful for display UI. More...
 
double HotSpot () const
 
double Intensity () const
 
const bool IsDirectionalLight () const
 
bool IsEnabled () const
 
const bool IsLinearLight () const
 
const bool IsPointLight () const
 
const bool IsRectangularLight () const
 
const bool IsSpotLight () const
 
bool IsValid (class ON_TextLog *text_log=nullptr) const override
 Tests an object to see if its data members are correctly initialized. More...
 
ON_3dVector Length () const
 
int LightIndex () const
 
const ON_wStringLightName () const
 
ON_3dPoint Location () const
 
ON_UUID ModelObjectId () const override
 virtual More...
 
ON::object_type ObjectType () const override
 Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on. More...
 
ON_Lightoperator= (const ON_Light &)=default
 
ON_3dVector PerpindicularDirection () const
 
double PowerCandela () const
 
double PowerLumens () const
 
double PowerWatts () const
 
bool Read (ON_BinaryArchive &) override
 Low level archive writing tool used by ON_BinaryArchive::ReadObject(). More...
 
void SetAmbient (ON_Color)
 
void SetAttenuation (double, double, double)
 
void SetAttenuation (const ON_3dVector &)
 
void SetDiffuse (ON_Color)
 
void SetDirection (const ON_3dVector &)
 
void SetHotSpot (double)
 
void SetIntensity (double)
 
void SetLength (const ON_3dVector &)
 
void SetLightIndex (int)
 
void SetLightName (const char *)
 
void SetLightName (const wchar_t *)
 
void SetLocation (const ON_3dPoint &)
 
void SetPowerCandela (double)
 
void SetPowerLumens (double)
 
void SetPowerWatts (double)
 
void SetShadowIntensity (double)
 
void SetSpecular (ON_Color)
 
void SetSpotAngleDegrees (double)
 
void SetSpotAngleRadians (double)
 
void SetSpotExponent (double)
 
void SetStyle (ON::light_style)
 
void SetWidth (const ON_3dVector &)
 
double ShadowIntensity () const
 
ON_Color Specular () const
 
double SpotAngleDegrees () const
 
double SpotAngleRadians () const
 
double SpotExponent () const
 
ON::light_style Style () const
 
bool Transform (const ON_Xform &) override
 Transforms the object. More...
 
ON_3dVector Width () const
 
bool Write (ON_BinaryArchive &) const override
 Low level archive writing tool used by ON_BinaryArchive::WriteObject(). More...
 
- Public Member Functions inherited from ON_Geometry
 ON_Geometry ()=default
 
 ON_Geometry (const ON_Geometry &)=default
 
 ~ON_Geometry ()=default
 
ON_BoundingBox BoundingBox () const
 Get object's 3d axis aligned bounding box. More...
 
virtual class ON_BrepBrepForm (class ON_Brep *brep=nullptr) const
 If possible, BrepForm() creates a brep form of the ON_Geometry. More...
 
virtual void ClearBoundingBox ()
 Some objects cache bounding box information. If you modify an object, then call ClearBoundingBox() to inform the object that any cached bounding boxes are invalid. More...
 
virtual ON_COMPONENT_INDEX ComponentIndex () const
 If this piece of geometry is a component in something larger, like an ON_BrepEdge in an ON_Brep, then this function returns the component index. More...
 
virtual bool EvaluatePoint (const class ON_ObjRef &objref, ON_3dPoint &P) const
 Evaluate the location of a point from the object reference. More...
 
bool GetBoundingBox (ON_BoundingBox &bbox, bool bGrowBox=false) const
 Get object's 3d axis aligned bounding box or the union of the input box with the object's bounding box. More...
 
bool GetBoundingBox (ON_3dPoint &bbox_min, ON_3dPoint &bbox_max, bool bGrowBox=false) const
 Get corners of object's 3d axis aligned bounding box or the union of the input box with the object's bounding box. More...
 
virtual bool GetTightBoundingBox (class ON_BoundingBox &tight_bbox, bool bGrowBox=false, const class ON_Xform *xform=nullptr) const
 Get tight bounding box. More...
 
virtual bool HasBrepForm () const
 Query an object to see if it has an ON_Brep form. Result: Returns true if the virtual ON_Geometry::BrepForm can compute an ON_Brep representation of this object. More...
 
virtual bool IsDeformable () const
 
virtual bool MakeDeformable ()
 If possible, converts the object into a form that can be accuratly modified with "squishy" transformations like projections, shears, an non-uniform scaling. More...
 
ON_Geometryoperator= (const ON_Geometry &)=default
 
bool Rotate (double sin_angle, double cos_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)
 Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule). More...
 
bool Rotate (double rotation_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)
 Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule). More...
 
bool Scale (double scale_factor)
 Scales the object by the specified facotor. The scale is centered at the origin. More...
 
virtual bool SwapCoordinates (int i, int j)
 Swaps object coordinate values with indices i and j. More...
 
bool Translate (const ON_3dVector &translation_vector)
 Translates the object along the specified vector. More...
 
- Public Member Functions inherited from ON_Object
 ON_Object () ON_NOEXCEPT
 
 ON_Object (const ON_Object &)
 
virtual ~ON_Object ()
 
virtual ON_AggregateComponentStatus AggregateComponentStatus () const
 Call whenever a component status setting is modifed by directly changing it on a component in a way that will result in any saved information about the parent object's aggretate component status becoming invalid. More...
 
bool AttachUserData (class ON_UserData *pUserData)
 Attach user data to an object. More...
 
unsigned int ClearAllComponentStates () const
 Set all active level component states to ON_ComponentStatus::NoneSet. More...
 
virtual unsigned int ClearComponentStates (ON_ComponentStatus states_to_clear) const
 Clear the specified states on every component. More...
 
virtual unsigned int ClearComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_clear) const
 Clear states on an individual component. More...
 
unsigned int CopyUserData (const ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution)
 Expert user tool that copies user data items with positive values of ON_UserData.m_userdata_copycount from source_object to "this. More...
 
void CopyUserData (const ON_Object &source_object)
 Calls CopyUserData(source_object,ON_Object::UserDataConflictResolution::source_object). More...
 
virtual ON__UINT32 DataCRC (ON__UINT32 current_remainder) const
 Returns a CRC calculated from the information that defines the object. This CRC can be used as a quick way to see if two objects are not identical. More...
 
virtual bool DeleteComponents (const ON_COMPONENT_INDEX *ci_list, size_t ci_count)
 Delete the portions of the object identified in ci_list[]. More...
 
virtual void DestroyRuntimeCache (bool bDelete=true)
 Expert user function. If you are using openNURBS in its default configuration to read and write 3dm archives, you never need to call this function. Many objects employ lazy creation of (runtime) caches that save information to help speed geometric calculations. This function will destroy all runtime information. More...
 
bool DetachUserData (class ON_UserData *pUserData)
 Remove user data from an object. More...
 
void EmergencyDestroy ()
 Sets m_user_data_list = 0. More...
 
class ON_UserDataFirstUserData () const
 User data is stored as a linked list of ON_UserData classes. FirstUserData gets the first item in the linked list. This is the most recent item attached using AttachUserData(). Remark: To iterate through all the user data on an object, call FirstUserData() and then use ON_UserData::Next() to traverse the list. More...
 
virtual unsigned int GetComponentsWithSetStates (ON_ComponentStatus states_filter, bool bAllEqualStates, ON_SimpleArray< ON_COMPONENT_INDEX > &components) const
 
class ON_UserDataGetUserData (const ON_UUID &userdata_uuid) const
 Get a pointer to user data. More...
 
bool GetUserString (const wchar_t *key, ON_wString &string_value) const
 Get user string from the object. More...
 
int GetUserStringKeys (ON_ClassArray< ON_wString > &user_string_keys) const
 Get a list of all user string keys on the object. More...
 
int GetUserStrings (ON_ClassArray< ON_UserString > &user_strings) const
 Get a list of all user strings on the object. More...
 
bool IsKindOf (const ON_ClassId *pClassId) const
 Low level tool to test if an object is derived from a specified class. More...
 
virtual void MarkAggregateComponentStatusAsNotCurrent () const
 Call whenever a component status setting is modifed by directly changing it on a component in a way that will result in any saved information about the parent object's aggretate component status becoming invalid. More...
 
virtual void MemoryRelocate ()
 The MemoryRelocate() function is called when an object's location in memory is changed. For example, if an object resides in a chunk of memory that is grown by calling a realloc that has to allocate a new chunk and copy the contents of the old chunk to the new chunk, then the location of the object's memory changes. In practice this happens when classes derived from ON_Object are stored in dynamic arrays, like the default implementation of ON_ObjectArray<>'s that use realloc to grow the dynamic array. More...
 
unsigned int MoveUserData (ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution, bool bDeleteAllSourceItems)
 Expert user tool that moves user data items from source_object to "this. More...
 
void MoveUserData (ON_Object &source_object)
 Calls MoveUserData(source_object,ON_Object::UserDataConflictResolution::source_object,true). More...
 
ON_Objectoperator= (const ON_Object &)
 
void PurgeUserData ()
 PurgeUserData() removes all user data from object. More...
 
virtual unsigned int SetComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_set) const
 Set states on an individual component. More...
 
virtual unsigned int SetComponentStatus (ON_COMPONENT_INDEX component_index, ON_ComponentStatus status_to_copy) const
 Copy status settings to an individual component. More...
 
bool SetUserString (const wchar_t *key, const wchar_t *string_value)
 Attach a user string to the object. This information will perisist through copy construction, operator=, and file IO. More...
 
int SetUserStrings (int count, const ON_UserString *user_strings, bool bReplace)
 Append entries to the user string list More...
 
virtual unsigned int SizeOf () const
 
void TransformUserData (const class ON_Xform &xform)
 Objects derived from ON_Geometry must call TransformUserData() in their Transform() member function. More...
 
virtual bool UpdateReferencedComponents (const class ON_ComponentManifest &source_manifest, const class ON_ComponentManifest &destination_manifest, const class ON_ManifestMap &manifest_map)
 Uses the destination_manifest to update references to other components. This is typically done when a component's references came from a "source" context and are being updated to the "destination" context. For example, inserting one model into another when index, id, and name conflicts need to be resolved at the time of insertion. More...
 
int UserStringCount () const
 

Public Attributes

ON_Color m_ambient
 
ON_3dVector m_attenuation
 attenuation settings - ignored for "directional" and "ambient" lights More...
 
bool m_bOn
 
ON_Color m_diffuse
 
ON_3dVector m_direction
 
double m_hotspot
 
double m_intensity
 
ON_3dVector m_length
 
ON_UUID m_light_id
 
int m_light_index
 
ON_wString m_light_name
 
ON_3dPoint m_location
 
double m_shadow_intensity
 shawdow casting More...
 
ON_Color m_specular
 
double m_spot_angle
 spot settings - ignored for non-spot lights More...
 
double m_spot_exponent
 
ON::light_style m_style
 
double m_watts
 
ON_3dVector m_width
 

Static Public Attributes

static const ON_Light Unset
 
- Static Public Attributes inherited from ON_Geometry
static const ON_Geometry Unset
 

Additional Inherited Members

- Public Types inherited from ON_Object
enum  UserDataConflictResolution : unsigned char {
  UserDataConflictResolution::destination_object = 0, UserDataConflictResolution::source_object = 1, UserDataConflictResolution::source_copycount_gt = 2, UserDataConflictResolution::source_copycount_ge = 3,
  UserDataConflictResolution::destination_copycount_gt = 4, UserDataConflictResolution::destination_copycount_ge = 5, UserDataConflictResolution::delete_item = 6
}
 When a userdata item is copied or moved from a source object to a destination object, the ON_Object::UserDataConflictResolution enum values specify how conficts are resolved. Remark: A userdata item "conflict" occurs when both the destination and source object have a user data item with the same value of ON_UserData::m_userdata_uuid. More...
 

Constructor & Destructor Documentation

◆ ON_Light() [1/2]

ON_Light::ON_Light ( )

◆ ~ON_Light()

ON_Light::~ON_Light ( )

◆ ON_Light() [2/2]

ON_Light::ON_Light ( const ON_Light )
default

Member Function Documentation

◆ Ambient()

ON_Color ON_Light::Ambient ( ) const

◆ Attenuation() [1/2]

ON_3dVector ON_Light::Attenuation ( ) const

◆ Attenuation() [2/2]

double ON_Light::Attenuation ( double  ) const

◆ CoordinateSystem()

ON::coordinate_system ON_Light::CoordinateSystem ( ) const

◆ Default()

void ON_Light::Default ( )

◆ Diffuse()

ON_Color ON_Light::Diffuse ( ) const

◆ Dimension()

int ON_Light::Dimension ( ) const
overridevirtual

Dimension of the object.

Returns
Dimension of the object.

The dimension is typically three. For parameter space trimming curves the dimension is two. In rare cases the dimension can be one or greater than three.

Reimplemented from ON_Geometry.

◆ Direction()

ON_3dVector ON_Light::Direction ( ) const

◆ Dump()

void ON_Light::Dump ( ON_TextLog ) const
overridevirtual

Creates a text dump of the object.

Dump() is intended for debugging and is not suitable for creating high quality text descriptions of an object.

The default implementations of this virtual function prints the class's name.

Reimplemented from ON_Object.

◆ Enable()

bool ON_Light::Enable ( bool  = true)

◆ GetBBox()

bool ON_Light::GetBBox ( double *  boxmin,
double *  boxmax,
bool  bGrowBox = false 
) const
overridevirtual

virtual ON_Geometry GetBBox override

Reimplemented from ON_Geometry.

◆ GetLightXform()

bool ON_Light::GetLightXform ( const ON_Viewport vp,
ON::coordinate_system  dest_cs,
ON_Xform xform 
) const

A light's location and direction can be defined with respect to world, camera, or view coordinates. GetLightXform gets the transformation from the light's intrinsic coordinate system to the destination coordinate system specified by dest_cs.

Parameters
vp[in] viewport where light is being used
dest_cs[in] destination coordinate system
xform[out] transformation from the light's intrinsic coordinate system to cs.
Returns
true if successful.

◆ GetSpotLightRadii()

bool ON_Light::GetSpotLightRadii ( double *  inner_radius,
double *  outer_radius 
) const

The spotlight radii are useful for display UI.

◆ HotSpot()

double ON_Light::HotSpot ( ) const

◆ Intensity()

double ON_Light::Intensity ( ) const

◆ IsDirectionalLight()

const bool ON_Light::IsDirectionalLight ( ) const

◆ IsEnabled()

bool ON_Light::IsEnabled ( ) const

◆ IsLinearLight()

const bool ON_Light::IsLinearLight ( ) const

◆ IsPointLight()

const bool ON_Light::IsPointLight ( ) const

◆ IsRectangularLight()

const bool ON_Light::IsRectangularLight ( ) const

◆ IsSpotLight()

const bool ON_Light::IsSpotLight ( ) const

◆ IsValid()

bool ON_Light::IsValid ( class ON_TextLog text_log = nullptr) const
overridevirtual

Tests an object to see if its data members are correctly initialized.

Parameters
text_log[in] if the object is not valid and text_log is not nullptr, then a brief englis description of the reason the object is not valid is appened to the log. The information appended to text_log is suitable for
lowlevel debugging purposes by programmers and is not intended to be useful as a high level user interface tool.
Returns
table true object is valid false object is invalid, uninitialized, etc.

Reimplemented from ON_Geometry.

◆ Length()

ON_3dVector ON_Light::Length ( ) const

◆ LightIndex()

int ON_Light::LightIndex ( ) const

◆ LightName()

const ON_wString& ON_Light::LightName ( ) const

◆ Location()

ON_3dPoint ON_Light::Location ( ) const

◆ ModelObjectId()

ON_UUID ON_Light::ModelObjectId ( ) const
overridevirtual

virtual

Reimplemented from ON_Object.

◆ ObjectType()

ON::object_type ON_Light::ObjectType ( ) const
overridevirtual

Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.

Returns

ON::object_type enum value.

The default implementation of this virtual function returns ON::unknown_object_type

Reimplemented from ON_Object.

◆ operator=()

ON_Light& ON_Light::operator= ( const ON_Light )
default

◆ PerpindicularDirection()

ON_3dVector ON_Light::PerpindicularDirection ( ) const

◆ PowerCandela()

double ON_Light::PowerCandela ( ) const

◆ PowerLumens()

double ON_Light::PowerLumens ( ) const

◆ PowerWatts()

double ON_Light::PowerWatts ( ) const

◆ Read()

bool ON_Light::Read ( ON_BinaryArchive binary_archive)
overridevirtual

Low level archive writing tool used by ON_BinaryArchive::ReadObject().

Parameters
binary_archivearchive to read from
Returns
Returns true if the read is successful.

Use ON_BinaryArchive::ReadObject() to read objects. This Read() function should read the objects definition back into its data members.

The default implementation of this virtual function returns false and does nothing.

Reimplemented from ON_Object.

◆ SetAmbient()

void ON_Light::SetAmbient ( ON_Color  )

◆ SetAttenuation() [1/2]

void ON_Light::SetAttenuation ( double  ,
double  ,
double   
)

◆ SetAttenuation() [2/2]

void ON_Light::SetAttenuation ( const ON_3dVector )

◆ SetDiffuse()

void ON_Light::SetDiffuse ( ON_Color  )

◆ SetDirection()

void ON_Light::SetDirection ( const ON_3dVector )

◆ SetHotSpot()

void ON_Light::SetHotSpot ( double  )

◆ SetIntensity()

void ON_Light::SetIntensity ( double  )

◆ SetLength()

void ON_Light::SetLength ( const ON_3dVector )

◆ SetLightIndex()

void ON_Light::SetLightIndex ( int  )

◆ SetLightName() [1/2]

void ON_Light::SetLightName ( const char *  )

◆ SetLightName() [2/2]

void ON_Light::SetLightName ( const wchar_t *  )

◆ SetLocation()

void ON_Light::SetLocation ( const ON_3dPoint )

◆ SetPowerCandela()

void ON_Light::SetPowerCandela ( double  )

◆ SetPowerLumens()

void ON_Light::SetPowerLumens ( double  )

◆ SetPowerWatts()

void ON_Light::SetPowerWatts ( double  )

◆ SetShadowIntensity()

void ON_Light::SetShadowIntensity ( double  )

◆ SetSpecular()

void ON_Light::SetSpecular ( ON_Color  )

◆ SetSpotAngleDegrees()

void ON_Light::SetSpotAngleDegrees ( double  )

◆ SetSpotAngleRadians()

void ON_Light::SetSpotAngleRadians ( double  )

◆ SetSpotExponent()

void ON_Light::SetSpotExponent ( double  )

◆ SetStyle()

void ON_Light::SetStyle ( ON::light_style  )

◆ SetWidth()

void ON_Light::SetWidth ( const ON_3dVector )

◆ ShadowIntensity()

double ON_Light::ShadowIntensity ( ) const

◆ Specular()

ON_Color ON_Light::Specular ( ) const

◆ SpotAngleDegrees()

double ON_Light::SpotAngleDegrees ( ) const

◆ SpotAngleRadians()

double ON_Light::SpotAngleRadians ( ) const

◆ SpotExponent()

double ON_Light::SpotExponent ( ) const

◆ Style()

ON::light_style ON_Light::Style ( ) const

◆ Transform()

bool ON_Light::Transform ( const ON_Xform xform)
overridevirtual

Transforms the object.

Parameters
xform[in] transformation to apply to object. If xform.IsSimilarity() is zero, then you may want to call MakeSquishy() before calling Transform.

Classes derived from ON_Geometry should call ON_Geometry::Transform() to handle user data transformations and then transform their definition.

See also
ON_Geometry::IsDeformable();,

Reimplemented from ON_Geometry.

◆ Width()

ON_3dVector ON_Light::Width ( ) const

◆ Write()

bool ON_Light::Write ( ON_BinaryArchive binary_archive) const
overridevirtual

Low level archive writing tool used by ON_BinaryArchive::WriteObject().

Parameters
binary_archivearchive to write to
Returns
Returns true if the write is successful.

Use ON_BinaryArchive::WriteObject() to write objects. This Write() function should just write the specific definition of this object. It should not write and any chunk typecode or length information.

The default implementation of this virtual function returns false and does nothing.

Reimplemented from ON_Object.

Member Data Documentation

◆ m_ambient

ON_Color ON_Light::m_ambient

◆ m_attenuation

ON_3dVector ON_Light::m_attenuation

attenuation settings - ignored for "directional" and "ambient" lights

◆ m_bOn

bool ON_Light::m_bOn

◆ m_diffuse

ON_Color ON_Light::m_diffuse

◆ m_direction

ON_3dVector ON_Light::m_direction

◆ m_hotspot

double ON_Light::m_hotspot

◆ m_intensity

double ON_Light::m_intensity

◆ m_length

ON_3dVector ON_Light::m_length

◆ m_light_id

ON_UUID ON_Light::m_light_id

◆ m_light_index

int ON_Light::m_light_index

◆ m_light_name

ON_wString ON_Light::m_light_name

◆ m_location

ON_3dPoint ON_Light::m_location

◆ m_shadow_intensity

double ON_Light::m_shadow_intensity

shawdow casting

◆ m_specular

ON_Color ON_Light::m_specular

◆ m_spot_angle

double ON_Light::m_spot_angle

spot settings - ignored for non-spot lights

◆ m_spot_exponent

double ON_Light::m_spot_exponent

◆ m_style

ON::light_style ON_Light::m_style

◆ m_watts

double ON_Light::m_watts

◆ m_width

ON_3dVector ON_Light::m_width

◆ Unset

const ON_Light ON_Light::Unset
static