OdPrcAmbientLight Class

Class Hierarchy

Syntax

C++

class OdPrcAmbientLight : public OdPrcContentLight;

File

PrcAmbientLight.h

Description

Class representing data about ambient illumination of a scene. It contains information about an entity and four indexes to describe its ambient illumination.

Group

PRC Graphical Classes

Public Methods

	Name	Description
	~OdPrcBase	Destroys an instance of a PRC entity.

OdPrcBase Methods

	Name	Description
	attributeData	This is the overview for the attributeData method overload.
	gsNode	Returns the OdGsCache object currently assigned to the PRC entity.
	id	Returns the PRC entity ID.
	isPersistent	Returns whether the PRC entity is persistent (true) or not (false).
	name	This is the overview for the name method overload.
	prcType	Returns the type of the PRC entity.
	setGsNode	Assigns the specified OdGsCache to the PRC entity.

OdPrcReferencedBase Class

	Name	Description
	cadIdentifier	Returns the current CAD identifier for the PRC object.
	cadPersistentIdentifier	Returns the current persistent CAD identifier for the PRC object.
	calculateUniqueName	Returns an explicit unique name for "this" entity that can be referenced through PDF or JavaScript. In the case of error, it returns an empty string.
	id	Returns the current object identifier for the object.
	isPersistent	Returns true if the object is persistent or false in the other case.
	objectId	Returns the PRC object identifier.
	setCADIdentifier	Sets a new CAD identifier value for the PRC object.
	setCADPersistentIdentifier	Sets a new persistent CAD identifier value for the PRC object.
	setObjectId	Sets a new PRC object identifier.

OdPrcContentLight Class

	Name	Description
	ambient	Returns the current value of the ambient index.
	diffuse	Returns the current diffuse index value.
	emissive	Returns the current emissive index value.
	getAmbient	Returns ambient color. Will throw an exception in case of uninitialized object.
	getDiffuse	Returns diffuse color. Will throw an exception in case of uninitialized object.
	getEmissive	Returns emissive color. Will throw an exception in case of uninitialized object.
	getSpecular	Returns the specular color. Will throw an exception in case of uninitialized object.
	setAmbient	This is the overview for the setAmbient method overload.
	setDiffuse	This is the overview for the setDiffuse method overload.
	setEmissive	This is the overview for the setEmissive method overload.
	setSpecular	This is the overview for the setSpecular method overload.
	specular	Returns the current specular index value.

Send feedback about this topic