Class SBDDocumentLight

ClassList > SBDDocumentLight

This class describes a light. More...

• #include <SBDDocumentLight.hpp>

Inherits the following classes: SBDDataGraphNode

Public Types inherited from SBDDataGraphNode

See SBDDataGraphNode

Type	Name
enum	RenderingPass The rendering pass.
enum	Type The type of the data graph node.

Public Functions

Type	Name
	SBDDocumentLight () Constructs a light.
	SBDDocumentLight (const std::string & name) Constructs a light with name name .
virtual SBDDocumentLight *	clone () override Returns a copy of the node and its descendants.
virtual void	collectAmbientOcclusion (const SBPosition3 & boxOrigin, const SBPosition3 & boxSize, unsigned int nCellsX, unsigned int nCellsY, unsigned int nCellsZ, float * ambientOcclusionData) To collect ambient occlusion data.
void	connectDocumentSignalToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBDocumentEvent *) functionPointer, SBCReferenceTarget * nextReferenceTarget=0, void(SBCReferenceTarget::*)(SBDocumentEvent *) nextFunctionPointer=0) Connects the document signal to a slot.
void	disconnectDocumentSignalFromSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBDocumentEvent *) functionPointer) Disconnects the document signal from a slot.
bool	documentSignalIsConnectedToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBDocumentEvent *) functionPointer) const Returns true if and only if the document signal is connected to the slot.
virtual void	expandBounds (SBIAPosition3 & bounds) const Expands the bounds to make sure the label fits inside them.
bool	getActiveFlag () const Returns the active flag.
const SBColor &	getColor () const Returns the color.
const SBQuantity::power &	getDefaultPower () const Returns the default power.
const SBQuantity::length &	getDefaultRadius () const Returns the default radius.
const SBQuantity::power &	getMaximumPower () const Returns the maximum power.
const SBQuantity::length &	getMaximumRadius () const Returns the maximum radius.
const SBQuantity::power &	getMinimumPower () const Returns the minimum power.
const SBQuantity::length &	getMinimumRadius () const Returns the minimum radius.
SBDDocumentLight *	getNextLight () const Returns the next light in the document.
SBPosition3 const &	getPosition () const Returns the position.
const SBQuantity::power &	getPower () const Returns the power.
const SBQuantity::power &	getPowerSingleStep () const Returns the single step for power.
SBDDocumentLight *	getPreviousLight () const Returns the previous light in the document.
const SBQuantity::length &	getRadius () const Returns the radius.
const SBQuantity::length &	getRadiusSingleStep () const Returns the single step for radius.
virtual SBDDataGraphNode::Type	getType () override const Returns the type of the data graph node.
virtual bool	isSerializable () override const Returns true __
virtual void	print (unsigned int offset=0) override const Prints the light.
virtual void	serialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override const Serializes the light.
void	setActiveFlag (bool activeFlag) Sets the active flag.
void	setColor (const SBColor & color) Sets the color.
void	setPosition (const SBPosition3 & position) Sets the position.
void	setPosition (SBPosition3 const & newPosition, SBPosition3 const & oldPosition) Sets the position.
void	setPower (const SBQuantity::power & power) Sets the power.
void	setRadius (const SBQuantity::length & radius) Sets the radius.
virtual void	unserialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override Unserializes the light.
virtual	~SBDDocumentLight () Destructs the light.

Public Functions inherited from SBDDataGraphNode

See SBDDataGraphNode

Type	Name
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBCClassProxy *, GetProxy)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, This)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetParent)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetThis)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetNextNode)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetPreviousNode)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDocument *, GetDocument)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetRoot)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, unsigned int, GetNodeIndex)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode::Type, GetType)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, bool, GetSelectionFlag)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, bool, GetLockedFlag)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, bool, GetVisibilityFlag)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, bool, GetHighlightingFlag)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, unsigned int, GetFlags)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, std::string, GetName)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, std::string, GetClass)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, std::string, GetElement)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBCContainerUUID, GetElementUUID)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, All)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, None)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsAtom)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsBond)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsStructuralNode)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsStructuralModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsVisualModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsMesh)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsLight)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsInteractionModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsDynamicalModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsPropertyModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSimulator)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsBallAndStick)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsLicorice)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsVanDerWaals)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsCartoon)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsRibbon)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsTube)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsGaussianSurface)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSolventAccessibleSurface)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSolventExcludedSurface)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, HasMaterial)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, OwnsMaterial)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsLocked)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSerializable)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsCreated)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsErased)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSelected)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsVisible)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsHighlighted)
	SB_NODE_PREDICATE_1 (SB_SBDDATAGRAPH_EXPORT, IsType, SBDDataGraphNode::Type)
	SB_NODE_PREDICATE_1 (SB_SBDDATAGRAPH_EXPORT, HasOneOf, SBNodeIndexer)
virtual bool	addChild (SBDDataGraphNode * node, SBDDataGraphNode * nextNode=nullptr) Adds a child to the node.
bool	addMaterial (SBDDataGraphNodeMaterial * material) Adds a material.
bool	baseSignalIsConnectedToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBBaseEvent *) functionPointer) const Returns true when the base signal is connected to a slot.
virtual bool	canAddChild (const SBDDataGraphNode * node, const SBDDataGraphNode * nextNode=nullptr) const Returns whether this node can add node as a child.
virtual bool	canAddChildType (SBDDataGraphNode::Type nodeType) const Returns whether this node can add a node with type nodeType as a child.
bool	canAddMaterial () const Returns whether can add a material to the node based on its type.
virtual bool	canHaveDescendantType (SBDDataGraphNode::Type nodeType) const Returns whether this node can have a node with type nodeType as a descendant.
virtual SBDDataGraphNode *	clone () Returns a copy of the node and its descendants.
void	connectBaseSignalToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBBaseEvent *) functionPointer, SBCReferenceTarget * nextReferenceTarget=0, void(SBCReferenceTarget::*)(SBBaseEvent *) nextFunctionPointer=0) Connects the base signal to a slot.
unsigned int	countNodes (SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Counts nodes based on a nodeType , a selection status and avisitPredicate , with or without dependencies.
unsigned int	countNodes (const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Counts nodes based on a selectionPredicate and avisitPredicate , with or without dependencies.
void	create () Creates the node.
bool	descendsFrom (const SBDDataGraphNode * node) const Returns true if and only if this node isnode , or descends from it.
bool	descendsFrom (const SBNodeIndexer & nodeIndexer) const Returns true if and only if this node is one of the nodes of thenodeIndexer , or descends from one of them.
bool	descendsFrom (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) const Returns true if and only if this node is one of the nodes of thenodePointerIndexer , or descends from one of them.
void	disconnectBaseSignalFromSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBBaseEvent *) functionPointer) Disconnects the base signal from a slot.
virtual void	display (RenderingPass renderingPass) Displays the node.
virtual void	display () Displays the node (deprecated)
virtual void	displayForSelection () Displays the node for selection purposes (deprecated)
virtual void	displayForShadow () Displays the node for shadowing purposes (deprecated)
void	erase () Erases the node.
virtual void	forEachNodeDepthFirst (void(*)(SBDDataGraphNode *node) action) Performs the action on this node.
virtual void	forEachNodeDepthFirst (SBCClass * object, void(SBCClass::*)(SBDDataGraphNode *node) action) Performs the objects 'saction on this node.
unsigned int	getDefaultOpacity () const Returns the default opacity.
unsigned int	getDefaultTransparency () const Returns the default transparency.
SBDDocument *	getDocument () const Returns the document the node belongs to.
virtual unsigned int	getFlags () const Returns the flags.
virtual std::string	getHierarchyString (const std::string & separator=" / ", bool includeNodeType=false) const Returns a string with hierarchical information on the node and its parents names.
bool	getHighlightingFlag () const Returns the highlighting flag.
virtual unsigned int	getInheritedFlags () const Returns the inherited flags.
float	getInheritedOpacity () const Returns the cumulative opacity, when taking into account the ascendants.
float	getInheritedTransparency () const Returns the cumulative transparency, when taking into account the ascendants.
virtual bool	getLockedFlag () const Returns the locked flag.
SBDDataGraphNodeMaterial *	getMaterial () const Returns the material.
SBDDataGraphNode *	getMaterialOwner () const Returns the node whose material is inherited.
unsigned int	getMaximumOpacity () const Returns the maximum opacity.
unsigned int	getMaximumTransparency () const Returns the maximum transparency.
unsigned int	getMinimumOpacity () const Returns the minimum opacity.
unsigned int	getMinimumTransparency () const Returns the minimum transparency.
virtual SBQuantity::mass	getMolecularWeight () Returns the molecular weight.
virtual std::string const &	getName () const Returns the name of the node.
SBDDataGraphNode *	getNextNode () const Returns the pointer to the next node in the children of the node's parent.
SBDDataGraphNode *	getNextNode (SBDDataGraphNode::Type nodeType) const Returns the pointer to the next node with type nodeType in the children of the node's parent.
unsigned int	getNodeIndex () const Returns the node index (unique in the whole data graph, but non-persistent)
SBUUID	getNodeUUID () const Returns the node UUID.
virtual void	getNodes (SBNodeIndexer & nodeIndexer, SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Collects nodes into nodeIndexer , based on anodeType , a selection status and avisitPredicate , with or without dependencies.
virtual void	getNodes (SBNodeIndexer & nodeIndexer, const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Collects nodes into nodeIndexer , based on aselectionPredicate and avisitPredicate , with or without dependencies.
virtual unsigned int	getNumberOfAtoms () Returns the number of atoms.
virtual unsigned int	getNumberOfCarbons () Returns the number of carbons.
virtual unsigned int	getNumberOfChains () Returns the number of chains.
virtual unsigned int	getNumberOfCoarseGrainedAtoms () Returns the number of coarse-grained atoms.
virtual unsigned int	getNumberOfHydrogens () Returns the number of hydrogens.
virtual unsigned int	getNumberOfMolecules () Returns the number of molecules.
virtual unsigned int	getNumberOfNitrogens () Returns the number of nitrogens.
virtual unsigned int	getNumberOfOtherAtoms () Returns the number of other atoms.
virtual unsigned int	getNumberOfOxygens () Returns the number of oxygens.
virtual unsigned int	getNumberOfResidues () Returns the number of residues.
virtual unsigned int	getNumberOfSegments () Returns the number of segments.
virtual unsigned int	getNumberOfStructuralGroups () Returns the number of structural groups.
virtual unsigned int	getNumberOfStructuralModels () Returns the number of structural models.
virtual unsigned int	getNumberOfSulfurs () Returns the number of sulfurs.
virtual unsigned int	getOpacity () const Returns the opacity.
unsigned int	getOpacitySingleStep () const Returns the opacity single step.
std::string	getOpacitySuffix () const Returns the opacity suffix.
SBDDataGraphNode *	getParent () const Returns the parent of the node.
SBDDataGraphNode *	getPreviousNode () const Returns the pointer to the previous node in the children of the node's parent.
SBDDataGraphNode *	getPreviousNode (SBDDataGraphNode::Type nodeType) const Returns the pointer to the previous node with type nodeType in the children of the node's parent.
SBDDataGraphNode *	getRoot () const Returns the root of the hierarchy the node belongs to.
bool	getSelected () const Returns whether the node is selected.
bool	getSelectionFlag () const Returns the selection flag.
virtual int	getSumOfFormalCharges () Returns the sum of formal charges.
virtual float	getSumOfPartialCharges () Returns the sum of partial charges.
SBDDataGraphNode *	getThisNode () const Returns the pointer to this node.
virtual unsigned int	getTransparency () const Returns the transparency.
unsigned int	getTransparencySingleStep () const Returns the transparency single step.
std::string	getTransparencySuffix () const Returns the transparency suffix.
virtual Type	getType () const Returns the type of the data graph node.
std::string	getTypeString (bool humanReadable=false) const Returns a string describing the type of the data graph node.
bool	getVisibilityFlag () const Returns the visibility flag.
bool	getVisible () const Returns whether the node is visible.
bool	hasMaterial () const Returns whether the node has a material (by itself, or inherited)
virtual bool	hasNode (SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Returns whether the node has nodes based on a nodeType , a selection status and avisitPredicate , with or without dependencies.
virtual bool	hasNode (const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Returns whether the node has nodes based on a selectionPredicate and avisitPredicate , with or without dependencies.
bool	hasOneOf (const SBNodeIndexer & nodeIndexer) const Returns true if and only if this node is one of the nodes of thenodeIndexer , or is the ancestor of one of them, or is a group that stores one of them.
bool	hasOpacityRange () const Returns whether the node has the opacity range.
bool	hasTransparencyRange () const Returns whether the node has the transparency range.
bool	isAtom () const Returns true when the node is an atom.
bool	isBallAndStick () const Returns true when the node is the default ball-and-stick visual model.
bool	isBond () const Returns true when the node is a bond.
bool	isCartoon () const Returns true when the node is the default cartoon visual model.
bool	isCreated () const Returns true if and only if the node is created.
bool	isDynamicalModel () const Returns true when the node is a dynamical model.
bool	isErased () const Returns true if and only if the node is erased.
bool	isGaussianSurface () const Returns true when the node is the default Gaussian surface visual model.
bool	isHighlighted () const Returns whether the node is highlighted.
bool	isIn (const SBDDataGraphNode * node) const Returns true if and only if this node isnode , or descends from it, or belongs to a group stored innode .
bool	isIn (const SBNodeIndexer & nodeIndexer) const Returns true if and only if this node is one of the nodes of thenodeIndexer , or descends from one of them, or belongs to a group stored in one of the nodes of thenodeIndexer .
bool	isIn (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) const Returns true if and only if this node is one of the nodes of thenodePointerIndexer , or descends from one of them, or belongs to a group stored in of the nodes of thenodePointerIndexer .
bool	isInteractionModel () const Returns true when the node is a interaction model.
bool	isLicorice () const Returns true when the node is the default licorice visual model.
bool	isLight () const Returns true when the node is a light.
virtual bool	isLocked () const Returns whether the node is locked.
bool	isMesh () const Returns true when the node is a mesh.
bool	isModel () const Returns true when the node is a model.
bool	isOneOf (const SBNodeIndexer & nodeIndexer) const Returns true if and only if this node is one of the nodes of thenodeIndexer .
bool	isOneOf (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) const Returns true if and only if this node is one of the nodes of thenodePointerIndexer .
bool	isPropertyModel () const Returns true when the node is a property model.
bool	isRibbon () const Returns true when the node is the default ribbon visual model.
bool	isSelected () const Returns whether the node is selected.
virtual bool	isSerializable () const Returns true when the class is serializable.
bool	isSimulator () const Returns true when the node is a simulator.
bool	isSolventAccessibleSurface () const Returns true when the node is the default solvent accessible surface visual model.
bool	isSolventExcludedSurface () const Returns true when the node is the default solvent excluded surface visual model.
bool	isStructuralModel () const Returns true when the node is a structural model.
bool	isStructuralNode () const Returns true when the node is a structural node.
bool	isTube () const Returns true when the node is the default tube visual model.
bool	isType (Type type) const Returns true when the type of the node corresponds totype .
bool	isVanDerWaals () const Returns true when the node is the default van der Waals visual model.
bool	isVisible () const Returns whether the node is visible.
bool	isVisualModel () const Returns true when the node is a visual model.
bool	ownsMaterial () const Returns whether the node owns a material.
virtual void	print (unsigned int offset=0) const Prints some debugging information.
virtual bool	removeChild (SBDDataGraphNode * node) Removes a child from the node.
bool	removeMaterial () Removes the material.
void	removeMaterialsFromDescendants () Removes materials from all nodes that descend from this node, but it does not remove the material from the node itself.
virtual void	serialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) const Serializes the node.
void	setHighlightingFlag (bool flag) Sets the highlighting flag.
virtual void	setLockedFlag (bool flag) Sets the locked flag.
virtual void	setName (const std::string & name) Sets the name of the node.
virtual void	setOpacity (unsigned int opacity) Sets the opacity.
void	setSelectionFlag (bool flag) Sets the selection flag.
virtual void	setTransparency (unsigned int transparency) Sets the transparency.
void	setVisibilityFlag (bool flag) Sets the visibility flag.
virtual void	unserialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) Unserializes the node.

Public Functions inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget () Builds the reference target.
unsigned int	getMemoryFootprint () const Returns the memory footprint.
void	printReferencesToOwners () const Prints the references to the owners of this reference target.
virtual	~SBCReferenceTarget () Destructor.

Public Static Functions inherited from SBDDataGraphNode

See SBDDataGraphNode

Type	Name
bool	canAddMaterial (SBDDataGraphNode::Type nodeType) Returns whether can add a material to a node of type nodeType .
void	clone (const SBNodeIndexer & sourceNodeIndexer, SBNodeIndexer & destinationNodeIndexer) Clones the nodes in sourceNodeIndexer (treated as a whole) and places the clones indestinationNodeIndexer .
void	forEachNodeInSelection (SBNodeIndexer & nodeIndexer, void(*)(SBDDataGraphNode *node) action) Performs the action for each node innodeIndexer __
void	forEachNodeInSelection (SBNodeIndexer & nodeIndexer, SBCClass * object, void(SBCClass::*)(SBDDataGraphNode *node) action) Performs the objects 'saction for each node innodeIndexer __
SBDDataGraphNode *	getNode (unsigned int nodeIndex) Returns the unique node corresponding to the node index nodeIndex .
std::string	getTypeString (Type type, bool humanReadable=false) Returns a string describing the type of the data graph node.

Protected Attributes inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
SBCReferenceTargetData *	dataPointer A pointer to the private data.

Protected Functions inherited from SBDDataGraphNode

See SBDDataGraphNode

Type	Name
	SBDDataGraphNode () Builds a data graph node.
	SBDDataGraphNode (SBDDataGraphNodeData * dataPointer) Builds a data graph node.
virtual	~SBDDataGraphNode () Destroys the node.

Protected Functions inherited from SBCReferenceTarget

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget (SBCReferenceTargetData * dataPointer) Protected constructor.
void	removeAllReferenceOwners () Stops all the reference owners from referencing this reference target.

Detailed Description

The SBDDocumentLight class implements all mechanisms related to lights in SAMSON.

Short name: SBLight

Public Functions Documentation

function SBDDocumentLight [1/2]

Constructs a light.

SBDDocumentLight::SBDDocumentLight () 

Constructs a default light.

Creates a new light with default properties.

---

function SBDDocumentLight [2/2]

Constructs a light with name name .

SBDDocumentLight::SBDDocumentLight (
    const std::string & name
) 

Constructs a light with the given name.

Parameters:

• name The name of the light.

---

function clone

Returns a copy of the node and its descendants.

virtual SBDDocumentLight * SBDDocumentLight::clone () override

Creates a copy of the light.

Returns:

A pointer to the cloned light.

Implements SBDDataGraphNode::clone

---

function collectAmbientOcclusion

To collect ambient occlusion data.

virtual void SBDDocumentLight::collectAmbientOcclusion (
    const SBPosition3 & boxOrigin,
    const SBPosition3 & boxSize,
    unsigned int nCellsX,
    unsigned int nCellsY,
    unsigned int nCellsZ,
    float * ambientOcclusionData
) 

Collects ambient occlusion data for the light.

Parameters:

• boxOrigin The origin of the bounding box.
• boxSize The size of the bounding box.
• nCellsX Number of cells in X direction.
• nCellsY Number of cells in Y direction.
• nCellsZ Number of cells in Z direction.
• ambientOcclusionData Pointer to the data buffer to be filled.

---

function connectDocumentSignalToSlot

Connects the document signal to a slot.

void SBDDocumentLight::connectDocumentSignalToSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBDocumentEvent *) functionPointer,
    SBCReferenceTarget * nextReferenceTarget=0,
    void(SBCReferenceTarget::*)( SBDocumentEvent *) nextFunctionPointer=0
) 

Parameters:

• referenceTarget The target object to connect to.
• functionPointer Pointer to the member function to be called on the target.
• nextReferenceTarget The next target for chaining (optional, may be null).
• nextFunctionPointer Pointer to the next function for chaining (optional, may be null).

---

function disconnectDocumentSignalFromSlot

Disconnects the document signal from a slot.

void SBDDocumentLight::disconnectDocumentSignalFromSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBDocumentEvent *) functionPointer
) 

Parameters:

• referenceTarget The target object to disconnect from.
• functionPointer The member function pointer to disconnect.

---

function documentSignalIsConnectedToSlot

Returns true if and only if the document signal is connected to the slot.

bool SBDDocumentLight::documentSignalIsConnectedToSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBDocumentEvent *) functionPointer
) const

Checks whether the document signal is connected to a given slot.

Parameters:

• referenceTarget The target object to check.
• functionPointer The member function pointer to check.

Returns:

true if the signal is connected to the slot, otherwise false.

---

function expandBounds

Expands the bounds to make sure the label fits inside them.

virtual void SBDDocumentLight::expandBounds (
    SBIAPosition3 & bounds
) const

Expands the given bounds to include the light's geometry.

Parameters:

• bounds The bounds to be expanded.

---

function getActiveFlag

Returns the active flag.

bool SBDDocumentLight::getActiveFlag () const

Returns whether the light is active.

Returns:

true if the light is active, otherwise false.

---

function getColor

Returns the color.

const SBColor & SBDDocumentLight::getColor () const

Returns the color of the light.

Returns:

A constant reference to the light's color.

---

function getDefaultPower

Returns the default power.

const SBQuantity::power & SBDDocumentLight::getDefaultPower () const

Returns the default power of the light.

Returns:

A constant reference to the default power.

---

function getDefaultRadius

Returns the default radius.

const SBQuantity::length & SBDDocumentLight::getDefaultRadius () const

Returns the default radius of the light.

Returns:

A constant reference to the default radius.

---

function getMaximumPower

Returns the maximum power.

const SBQuantity::power & SBDDocumentLight::getMaximumPower () const

Returns the maximum allowable power of the light.

Returns:

A constant reference to the maximum power.

---

function getMaximumRadius

Returns the maximum radius.

const SBQuantity::length & SBDDocumentLight::getMaximumRadius () const

Returns the maximum allowable radius of the light.

Returns:

A constant reference to the maximum radius.

---

function getMinimumPower

Returns the minimum power.

const SBQuantity::power & SBDDocumentLight::getMinimumPower () const

Returns the minimum allowable power of the light.

Returns:

A constant reference to the minimum power.

---

function getMinimumRadius

Returns the minimum radius.

const SBQuantity::length & SBDDocumentLight::getMinimumRadius () const

Returns the minimum allowable radius of the light.

Returns:

A constant reference to the minimum radius.

---

function getNextLight

Returns the next light in the document.

SBDDocumentLight * SBDDocumentLight::getNextLight () const

Retrieves the next light in the document.

Returns:

A pointer to the next light, or nullptr if none exists.

---

function getPosition

Returns the position.

SBPosition3 const & SBDDocumentLight::getPosition () const

Returns the position of the light.

Returns:

A constant reference to the light's position.

---

function getPower

Returns the power.

const SBQuantity::power & SBDDocumentLight::getPower () const

Returns the power of the light.

Returns:

A constant reference to the light's power.

---

function getPowerSingleStep

Returns the single step for power.

const SBQuantity::power & SBDDocumentLight::getPowerSingleStep () const

Returns the single step increment for the power parameter.

Returns:

A constant reference to the power single step.

---

function getPreviousLight

Returns the previous light in the document.

SBDDocumentLight * SBDDocumentLight::getPreviousLight () const

Retrieves the previous light in the document.

Returns:

A pointer to the previous light, or nullptr if none exists.

---

function getRadius

Returns the radius.

const SBQuantity::length & SBDDocumentLight::getRadius () const

Returns the radius of the light.

Returns:

A constant reference to the light's radius.

---

function getRadiusSingleStep

Returns the single step for radius.

const SBQuantity::length & SBDDocumentLight::getRadiusSingleStep () const

Returns the single step increment for the radius parameter.

Returns:

A constant reference to the radius single step.

---

function getType

Returns the type of the data graph node.

virtual SBDDataGraphNode::Type SBDDocumentLight::getType () override const

Returns the type identifier of the data graph node.

Returns:

The type identifier for a light node.

Implements SBDDataGraphNode::getType

---

function isSerializable

Returns true __

virtual bool SBDDocumentLight::isSerializable () override const

Indicates whether the light can be serialized.

Returns:

true because the light is serializable.

Implements SBDDataGraphNode::isSerializable

---

function print

Prints the light.

virtual void SBDDocumentLight::print (
    unsigned int offset=0
) override const

Prints the light's properties to the standard output.

Parameters:

• offset Number of tabs to indent the output.

Implements SBDDataGraphNode::print

---

function serialize

Serializes the light.

virtual void SBDDocumentLight::serialize (
    SBCSerializer * serializer,
    const SBNodeIndexer & nodeIndexer,
    const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
    const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
) override const

Serializes the light to a serializer.

Parameters:

• serializer The serializer to write data to.
• nodeIndexer The node indexer used for indexing nodes.
• sdkVersionNumber The SDK version number.
• classVersionNumber The class version number.

Implements SBDDataGraphNode::serialize

---

function setActiveFlag

Sets the active flag.

void SBDDocumentLight::setActiveFlag (
    bool activeFlag
) 

Sets the active flag of the light.

Parameters:

• activeFlag The new active flag value.

---

function setColor

Sets the color.

void SBDDocumentLight::setColor (
    const SBColor & color
) 

Sets the color of the light.

Parameters:

• color The new color.

---

function setPosition [1/2]

Sets the position.

void SBDDocumentLight::setPosition (
    const SBPosition3 & position
) 

Sets the position of the light.

Parameters:

• position The new position to set.

---

function setPosition [2/2]

Sets the position.

void SBDDocumentLight::setPosition (
    SBPosition3 const & newPosition,
    SBPosition3 const & oldPosition
) 

Sets the position of the light, providing both new and old positions for undo support.

Parameters:

• newPosition The new position.
• oldPosition The previous position.

---

function setPower

Sets the power.

void SBDDocumentLight::setPower (
    const SBQuantity::power & power
) 

Sets the power of the light.

Parameters:

• power The new power value.

---

function setRadius

Sets the radius.

void SBDDocumentLight::setRadius (
    const SBQuantity::length & radius
) 

Sets the radius of the light.

Parameters:

• radius The new radius value.

---

function unserialize

Unserializes the light.

virtual void SBDDocumentLight::unserialize (
    SBCSerializer * serializer,
    const SBNodeIndexer & nodeIndexer,
    const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
    const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
) override

Unserializes the light from a serializer.

Parameters:

• serializer The serializer to read data from.
• nodeIndexer The node indexer used for indexing nodes.
• sdkVersionNumber The SDK version number.
• classVersionNumber The class version number.

Implements SBDDataGraphNode::unserialize

---

function ~SBDDocumentLight

Destructs the light.

virtual SBDDocumentLight::~SBDDocumentLight () 

Destroys the light.

---