Interactive object for a light source. Each type of light source has it's own presentation: More...

#include <AIS_LightSource.hxx>

Inheritance diagram for AIS_LightSource:

[legend]

Public Member Functions
	AIS_LightSource (const occ::handle< Graphic3d_CLight > &theLightSource)
	Initializes the light source by copying Graphic3d_CLight settings.

const occ::handle< Graphic3d_CLight > &	Light () const
	Returns the light.

void	SetLight (const occ::handle< Graphic3d_CLight > &theLight)
	Set the light.

Public Member Functions inherited from AIS_InteractiveObject
virtual int	Signature () const
	Specifies additional characteristics of Interactive Object of Type(); -1 by default. Among the datums, this signature is attributed to the shape. The remaining datums have the following default signatures:

void	Redisplay (const bool AllModes=false)
	Updates the active presentation; if <AllModes> = true all the presentations inside are recomputed. IMPORTANT: It is preferable to call Redisplay method of corresponding AIS_InteractiveContext instance for cases when it is accessible. This method just redirects call to myCTXPtr, so this class field must be up to date for proper result.

bool	HasInteractiveContext () const
	Indicates whether the Interactive Object has a pointer to an interactive context.

AIS_InteractiveContext *	InteractiveContext () const
	Returns the context pointer to the interactive context.

virtual void	SetContext (const occ::handle< AIS_InteractiveContext > &aCtx)
	Sets the interactive context aCtx and provides a link to the default drawing tool or "Drawer" if there is none.

bool	HasOwner () const
	Returns true if the object has an owner attributed to it. The owner can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of, and takes the form of a transient.

const occ::handle< Standard_Transient > &	GetOwner () const
	Returns the owner of the Interactive Object. The owner can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of, and takes the form of a transient. There are two types of owners:

void	SetOwner (const occ::handle< Standard_Transient > &theApplicativeEntity)
	Allows you to attribute the owner theApplicativeEntity to an Interactive Object. This can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of. The owner takes the form of a transient.

void	ClearOwner ()
	Each Interactive Object has methods which allow us to attribute an Owner to it in the form of a Transient. This method removes the owner from the graphic entity.

occ::handle< AIS_InteractiveContext >	GetContext () const
	Returns the context pointer to the interactive context.

bool	HasPresentation () const
	Returns TRUE when this object has a presentation in the current DisplayMode()

occ::handle< Prs3d_Presentation >	Presentation () const
	Returns the current presentation of this object according to the current DisplayMode()

void	SetAspect (const occ::handle< Prs3d_BasicAspect > &anAspect)
	Sets the graphic basic aspect to the current presentation.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.

Public Member Functions inherited from SelectMgr_SelectableObject
	~SelectMgr_SelectableObject () override
	Clears all selections of the object.

virtual bool	AcceptShapeDecomposition () const
	Informs the graphic context that the interactive Object may be decomposed into sub-shapes for dynamic selection. The most used Interactive Object is AIS_Shape.

void	RecomputePrimitives ()
	Re-computes the sensitive primitives for all modes. IMPORTANT: Do not use this method to update selection primitives except implementing custom selection manager! This method does not take into account necessary BVH updates, but may invalidate the pointers it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection.

void	RecomputePrimitives (const int theMode)
	Re-computes the sensitive primitives which correspond to the <theMode>th selection mode. IMPORTANT: Do not use this method to update selection primitives except implementing custom selection manager! selection manager! This method does not take into account necessary BVH updates, but may invalidate the pointers it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection.

void	AddSelection (const occ::handle< SelectMgr_Selection > &aSelection, const int aMode)
	Adds the selection aSelection with the selection mode index aMode to this framework.

void	ClearSelections (const bool update=false)
	Empties all the selections in the SelectableObject <update> parameter defines whether all object's selections should be flagged for further update or not. This improved method can be used to recompute an object's selection (without redisplaying the object completely) when some selection mode is activated not for the first time.

const occ::handle< SelectMgr_Selection > &	Selection (const int theMode) const
	Returns the selection having specified selection mode or NULL.

bool	HasSelection (const int theMode) const
	Returns true if a selection corresponding to the selection mode theMode was computed for this object.

const NCollection_Sequence< occ::handle< SelectMgr_Selection > > &	Selections () const
	Return the sequence of selections.

void	ResetTransformation () override
	resets local transformation to identity.

void	UpdateTransformation () override
	Recomputes the location of the selection aSelection.

virtual void	UpdateTransformations (const occ::handle< SelectMgr_Selection > &aSelection)
	Updates locations in all sensitive entities from <aSelection> and in corresponding entity owners.

virtual void	HilightSelected (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const NCollection_Sequence< occ::handle< SelectMgr_EntityOwner > > &theSeq)
	Method which draws selected owners ( for fast presentation draw )

virtual void	ClearSelected ()
	Method which clear all selected owners belonging to this selectable object ( for fast presentation draw )

virtual void	ClearDynamicHighlight (const occ::handle< PrsMgr_PresentationManager > &theMgr)
	Method that needs to be implemented when the object manages selection and dynamic highlighting on its own. Clears or invalidates dynamic highlight presentation. By default it clears immediate draw of given presentation manager.

virtual void	HilightOwnerWithColor (const occ::handle< PrsMgr_PresentationManager > &thePM, const occ::handle< Prs3d_Drawer > &theStyle, const occ::handle< SelectMgr_EntityOwner > &theOwner)
	Method which hilight an owner belonging to this selectable object (for fast presentation draw)

virtual bool	IsAutoHilight () const
	If returns True, the old mechanism for highlighting selected objects is used (HilightSelected Method may be empty). If returns False, the HilightSelected method will be fully responsible for highlighting selected entity owners belonging to this selectable object.

virtual void	SetAutoHilight (const bool theAutoHilight)
	Set AutoHilight property to true or false.

occ::handle< Prs3d_Presentation >	GetHilightPresentation (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr)
	Creates or returns existing presentation for highlighting detected object.

occ::handle< Prs3d_Presentation >	GetSelectPresentation (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr)
	Creates or returns existing presentation for highlighting selected object.

virtual void	ErasePresentations (bool theToRemove)
	Removes presentations returned by GetHilightPresentation() and GetSelectPresentation().

void	SetZLayer (const Graphic3d_ZLayerId theLayerId) override
	Set Z layer ID and update all presentations of the selectable object. The layers mechanism allows drawing objects in higher layers in overlay of objects in lower layers.

void	UpdateSelection (const int theMode=-1)
	Sets update status FULL to selections of the object. Must be used as the only method of UpdateSelection from outer classes to prevent BVH structures from being outdated.

void	SetAssemblyOwner (const occ::handle< SelectMgr_EntityOwner > &theOwner, const int theMode=-1)
	Sets common entity owner for assembly sensitive object entities.

Bnd_Box	BndBoxOfSelected (const occ::handle< NCollection_Shared< NCollection_IndexedMap< occ::handle< SelectMgr_EntityOwner > > > > &theOwners)
	Returns a bounding box of sensitive entities with the owners given if they are a part of activated selection.

int	GlobalSelectionMode () const
	Returns the mode for selection of object as a whole; 0 by default.

virtual occ::handle< SelectMgr_EntityOwner >	GlobalSelOwner () const
	Returns the owner of mode for selection of object as a whole.

virtual const occ::handle< SelectMgr_EntityOwner > &	GetAssemblyOwner () const
	Returns common entity owner if the object is an assembly.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.

Public Member Functions inherited from PrsMgr_PresentableObject
NCollection_Sequence< occ::handle< PrsMgr_Presentation > > &	Presentations ()
	Return presentations.

Graphic3d_ZLayerId	ZLayer () const
	Get ID of Z layer for main presentation.

bool	IsMutable () const
	Returns true if object has mutable nature (content or location are be changed regularly). Mutable object will be managed in different way than static onces (another optimizations).

virtual void	SetMutable (const bool theIsMutable)
	Sets if the object has mutable nature (content or location will be changed regularly). This method should be called before object displaying to take effect.

const occ::handle< Graphic3d_ViewAffinity > &	ViewAffinity () const
	Return view affinity mask.

bool	HasDisplayMode () const
	Returns true if the Interactive Object has display mode setting overriding global setting (within Interactive Context).

int	DisplayMode () const
	Returns the display mode setting of the Interactive Object. The range of supported display mode indexes should be specified within object definition and filtered by AccepDisplayMode().

void	SetDisplayMode (const int theMode)
	Sets the display mode for the interactive object. An object can have its own temporary display mode, which is different from that proposed by the interactive context.

void	UnsetDisplayMode ()
	Removes display mode settings from the interactive object.

bool	HasHilightMode () const
	Returns true if the Interactive Object is in highlight mode.

int	HilightMode () const
	Returns highlight display mode. This is obsolete method for backward compatibility - use HilightAttributes() and DynamicHilightAttributes() instead.

void	SetHilightMode (const int theMode)
	Sets highlight display mode. This is obsolete method for backward compatibility - use HilightAttributes() and DynamicHilightAttributes() instead.

void	UnsetHilightMode ()
	Unsets highlight display mode.

virtual int	DefaultDisplayMode () const
	Returns the default display mode.

bool	ToBeUpdated (bool theToIncludeHidden=false) const
	Returns TRUE if any active presentation has invalidation flag.

void	SetToUpdate (int theMode)
	Flags presentation to be updated; UpdatePresentations() will recompute these presentations.

void	SetToUpdate ()
	flags all the Presentations to be Updated.

bool	IsInfinite () const
	Returns true if the interactive object is infinite; FALSE by default. This flag affects various operations operating on bounding box of graphic presentations of this object. For instance, infinite objects are not taken in account for View FitAll. This does not necessarily means that object is actually infinite, auxiliary objects might be also marked with this flag to achieve desired behavior.

void	SetInfiniteState (const bool theFlag=true)
	Sets if object should be considered as infinite.

PrsMgr_TypeOfPresentation3d	TypeOfPresentation3d () const
	Returns information on whether the object accepts display in HLR mode or not.

void	SetTypeOfPresentation (const PrsMgr_TypeOfPresentation3d theType)
	Set type of presentation.

PrsMgr_DisplayStatus	DisplayStatus () const
	Return presentation display status; PrsMgr_DisplayStatus_None by default.

const occ::handle< Prs3d_Drawer > &	Attributes () const
	Initializes the drawing tool theDrawer.

virtual void	SetAttributes (const occ::handle< Prs3d_Drawer > &theDrawer)
	Initializes the drawing tool theDrawer.

const occ::handle< Prs3d_Drawer > &	HilightAttributes () const
	Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalSelected and Prs3d_TypeOfHighlight_Selected defined within AIS_InteractiveContext::HighlightStyle().

virtual void	SetHilightAttributes (const occ::handle< Prs3d_Drawer > &theDrawer)
	Initializes the hilight drawing tool theDrawer.

const occ::handle< Prs3d_Drawer > &	DynamicHilightAttributes () const
	Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalDynamic and Prs3d_TypeOfHighlight_Dynamic defined within AIS_InteractiveContext::HighlightStyle().

virtual void	SetDynamicHilightAttributes (const occ::handle< Prs3d_Drawer > &theDrawer)
	Initializes the dynamic hilight drawing tool.

virtual void	UnsetHilightAttributes ()
	Clears settings provided by the hilight drawing tool theDrawer.

void	SynchronizeAspects ()
	Synchronize presentation aspects after their modification.

const occ::handle< Graphic3d_TransformPers > &	TransformPersistence () const
	Sets up Transform Persistence defining a special Local Coordinate system where this object should be located. Note that management of Transform Persistence object is more expensive than of the normal one, because it requires its position being recomputed basing on camera position within each draw call / traverse.

virtual void	SetTransformPersistence (const occ::handle< Graphic3d_TransformPers > &theTrsfPers)
	Sets up Transform Persistence defining a special Local Coordinate system where this object should be located. Note that management of Transform Persistence object is more expensive than of the normal one, because it requires its position being recomputed basing on camera position within each draw call / traverse.

const occ::handle< TopLoc_Datum3D > &	LocalTransformationGeom () const
	Return the local transformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.

void	SetLocalTransformation (const gp_Trsf &theTrsf)
	Sets local transformation to theTransformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.

void	SetLocalTransformation (const occ::handle< TopLoc_Datum3D > &theTrsf)
	Sets local transformation to theTransformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.

bool	HasTransformation () const
	Returns true if object has a transformation that is different from the identity.

const occ::handle< TopLoc_Datum3D > &	TransformationGeom () const
	Return the transformation taking into account transformation of parent object(s). Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.

const gp_Trsf &	LocalTransformation () const
	Return the local transformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.

const gp_Trsf &	Transformation () const
	Return the transformation taking into account transformation of parent object(s). Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.

const gp_GTrsf &	InversedTransformation () const
	Return inversed transformation.

const occ::handle< TopLoc_Datum3D > &	CombinedParentTransformation () const
	Return combined parent transformation.

virtual void	RecomputeTransformation (const occ::handle< Graphic3d_Camera > &theProjector)
	Calculates object presentation for specific camera position. Each of the views in the viewer and every modification such as rotation, for example, entails recalculation.

const occ::handle< Graphic3d_SequenceOfHClipPlane > &	ClipPlanes () const
	Set clip planes for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes.

virtual void	SetClipPlanes (const occ::handle< Graphic3d_SequenceOfHClipPlane > &thePlanes)
	Set clip planes for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes.

virtual void	AddClipPlane (const occ::handle< Graphic3d_ClipPlane > &thePlane)
	Adds clip plane for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes.

virtual void	RemoveClipPlane (const occ::handle< Graphic3d_ClipPlane > &thePlane)
	Removes previously added clip plane.

PrsMgr_PresentableObject *	Parent () const
	Returns children of the current object.

const NCollection_List< occ::handle< PrsMgr_PresentableObject > > &	Children () const
	Returns children of the current object.

virtual void	AddChild (const occ::handle< PrsMgr_PresentableObject > &theObject)
	Makes theObject child of current object in scene hierarchy.

void	AddChildWithCurrentTransformation (const occ::handle< PrsMgr_PresentableObject > &theObject)
	Makes theObject child of current object in scene hierarchy with keeping the current global transformation So the object keeps the same position/orientation in the global CS.

virtual void	RemoveChild (const occ::handle< PrsMgr_PresentableObject > &theObject)
	Removes theObject from children of current object in scene hierarchy.

void	RemoveChildWithRestoreTransformation (const occ::handle< PrsMgr_PresentableObject > &theObject)
	Removes theObject from children of current object in scene hierarchy with keeping the current global transformation. So the object keeps the same position/orientation in the global CS.

bool	HasOwnPresentations () const
	Returns true if object should have own presentations.

virtual void	BoundingBox (Bnd_Box &theBndBox)
	Returns bounding box of object correspondingly to its current display mode. This method requires presentation to be already computed, since it relies on bounding box of presentation structures, which are supposed to be same/close amongst different display modes of this object.

void	SetIsoOnTriangulation (const bool theIsEnabled)
	Returns the current facing model which is in effect.

Aspect_TypeOfFacingModel	CurrentFacingModel () const
	Returns the current facing model which is in effect.

void	SetCurrentFacingModel (const Aspect_TypeOfFacingModel theModel=Aspect_TOFM_BOTH_SIDE)
	change the current facing model apply on polygons for SetColor(), SetTransparency(), SetMaterial() methods default facing model is Aspect_TOFM_TWO_SIDE. This mean that attributes is applying both on the front and back face.

bool	HasColor () const
	Returns true if the Interactive Object has color.

virtual void	Color (Quantity_Color &theColor) const
	Returns the color setting of the Interactive Object.

virtual void	SetColor (const Quantity_Color &theColor)
	Only the interactive object knowns which Drawer attribute is affected by the color, if any (ex: for a wire,it's the wireaspect field of the drawer, but for a vertex, only the point aspect field is affected by the color). WARNING : Do not forget to set the corresponding fields here (hasOwnColor and myDrawer->SetColor())

virtual void	UnsetColor ()
	Removes color settings. Only the Interactive Object knows which Drawer attribute is affected by the color setting. For a wire, for example, wire aspect is the attribute affected. For a vertex, however, only point aspect is affected by the color setting.

bool	HasWidth () const
	Returns true if the Interactive Object has width.

double	Width () const
	Returns the width setting of the Interactive Object.

virtual void	SetWidth (const double theWidth)
	Allows you to provide the setting aValue for width. Only the Interactive Object knows which Drawer attribute is affected by the width setting.

virtual void	UnsetWidth ()
	Reset width to default value.

bool	HasMaterial () const
	Returns true if the Interactive Object has a setting for material.

virtual Graphic3d_NameOfMaterial	Material () const
	Returns the current material setting as enumeration value.

virtual void	SetMaterial (const Graphic3d_MaterialAspect &aName)
	Sets the material aMat defining this display attribute for the interactive object. Material aspect determines shading aspect, color and transparency of visible entities.

virtual void	UnsetMaterial ()
	Removes the setting for material.

bool	IsTransparent () const
	Returns true if there is a transparency setting.

virtual double	Transparency () const
	Returns the transparency setting. This will be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent.

virtual void	SetTransparency (const double aValue=0.6)
	Attributes a setting aValue for transparency. The transparency value should be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent. Warning At a value of 1.0, there may be nothing visible.

virtual void	UnsetTransparency ()
	Removes the transparency setting. The object is opaque by default.

virtual bool	HasPolygonOffsets () const
	Returns true if <myDrawer> has non-null shading aspect.

virtual void	PolygonOffsets (int &aMode, float &aFactor, float &aUnits) const
	Retrieves current polygon offsets settings from <myDrawer>.

virtual void	SetPolygonOffsets (const int aMode, const float aFactor=1.0, const float aUnits=0.0)
	Sets up polygon offsets for this object.

virtual void	UnsetAttributes ()
	Clears settings provided by the drawing tool aDrawer.

void	ToBeUpdated (NCollection_List< int > &ListOfMode) const
	pointer to the parent object

bool	ToPropagateVisualState () const
	Get value of the flag "propagate visual state" It means that the display/erase/color visual state is propagated automatically to all children; by default, the flag is true.

void	SetPropagateVisualState (const bool theFlag)
	Change the value of the flag "propagate visual state".

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Light properties
Returns TRUE if the light source name should be displayed; TRUE by default.
occ::handle< Graphic3d_CLight >	myLightSource
	displayed light source

occ::handle< Graphic3d_AspectMarker3d >	myDisabledMarkerAspect
	disabled light source marker style

occ::handle< Graphic3d_AspectLine3d >	myArrowLineAspectShadow
	arrow shadow style

occ::handle< Graphic3d_MarkerImage >	myMarkerImages [2]
	icon of disabled (0) and enabled (1) light

occ::handle< Select3D_SensitiveSphere >	mySensSphere
	sensitive sphere of directional light source

Aspect_TypeOfMarker	myMarkerTypes [2]
	icon of disabled (0) and enabled (1) light

Aspect_TypeOfMarker	myCodirMarkerType
	icon of arrow co-directional to camera direction (look from)

Aspect_TypeOfMarker	myOpposMarkerType
	icon of arrow opposite to camera direction (look at)

gp_Trsf	myLocTrsfStart
	object transformation before transformation

double	mySize
	presentation size

int	myNbArrows
	number of directional light arrows

int	myNbSplitsQuadric
	tessellation level for quadric surfaces

int	myNbSplitsArrow
	tessellation level for arrows

int	mySensSphereArcSize
	displayed light source

bool	myIsZoomable
	sensitive sphere arc size in pixels

bool	myIsDraggable
	flag to allow/disallow rotate directional light source by dragging

bool	myToDisplayName
	flag to show/hide name

bool	myToDisplayRange
	flag to show/hide range of positional/spot light

bool	myToSwitchOnClick
	flag to handle mouse click to turn light on/off

bool	ToDisplayName () const
	displayed light source

void	SetDisplayName (bool theToDisplay)
	Show/hide light source name.

bool	ToDisplayRange () const
	Returns TRUE to display light source range as sphere (positional light) or cone (spot light); TRUE by default. Has no effect for non-zoomable presentation.

void	SetDisplayRange (bool theToDisplay)
	Show/hide light source range shaded presentation.

double	Size () const
	Returns the size of presentation; 50 by default.

void	SetSize (double theSize)
	Sets the size of presentation.

int	ArcSize () const
	Returns Sensitive sphere arc size in pixels; 20 by default.

void	SetArcSize (int theSize)
	Sets the size of sensitive sphere arc.

bool	IsZoomable () const
	Returns TRUE if transform-persistence is allowed; TRUE by default for Ambient and Directional lights and FALSE by default for Positional and Spot lights.

void	SetZoomable (bool theIsZoomable)
	Sets if transform-persistence is allowed.

void	SetDraggable (bool theIsDraggable)
	Sets if dragging is allowed.

bool	ToSwitchOnClick () const
	Returns TRUE if mouse click will turn light on/off; TRUE by default.

void	SetSwitchOnClick (bool theToHandle)
	Sets if mouse click should turn light on/off.

int	NbArrows () const
	Returns a number of directional light arrows to display; 5 by default.

void	SetNbArrows (int theNbArrows)
	Returns a number of directional light arrows to display (supported values: 1, 3, 5, 9).

const occ::handle< Graphic3d_MarkerImage > &	MarkerImage (bool theIsEnabled) const
	Returns light source icon.

Aspect_TypeOfMarker	MarkerType (bool theIsEnabled) const
	Returns light source icon.

void	SetMarkerImage (const occ::handle< Graphic3d_MarkerImage > &theImage, bool theIsEnabled)
	Sets custom icon to light source.

void	SetMarkerType (Aspect_TypeOfMarker theType, bool theIsEnabled)
	Sets standard icon to light source.

int	NbSplitsQuadric () const
	Returns tessellation level for quadric surfaces; 30 by default.

void	SetNbSplitsQuadric (int theNbSplits)
	Sets tessellation level for quadric surfaces.

int	NbSplitsArrow () const
	Returns tessellation level for arrows; 20 by default.

void	SetNbSplitsArrow (int theNbSplits)
	Sets tessellation level for arrows.

AIS_KindOfInteractive	Type () const override
	Returns kind of the object.

bool	AcceptDisplayMode (const int theMode) const override
	Return true if specified display mode is supported: 0 for main presentation and 1 for highlight.

void	Compute (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const occ::handle< Prs3d_Presentation > &thePrs, const int theMode) override
	Computes selection sensitive zones(triangulation) for light source presentation.

void	ComputeSelection (const occ::handle< SelectMgr_Selection > &theSel, const int theMode) override
	Fills presentation.

bool	ProcessDragging (const occ::handle< AIS_InteractiveContext > &theCtx, const occ::handle< V3d_View > &theView, const occ::handle< SelectMgr_EntityOwner > &theOwner, const NCollection_Vec2< int > &theDragFrom, const NCollection_Vec2< int > &theDragTo, const AIS_DragAction theAction) override
	Drag object in the viewer.

void	setLocalTransformation (const occ::handle< TopLoc_Datum3D > &theTrsf) override
	Sets new local transformation, which is propagated to Graphic3d_CLight instance.

virtual void	updateLightLocalTransformation ()
	Updates local transformation basing on a type of light source.

virtual void	updateLightTransformPersistence ()
	Updates transform persistence basing on a type of light source.

virtual void	updateLightAspects ()
	Sets color of light.

virtual void	computeAmbient (const occ::handle< Prs3d_Presentation > &thePrs, const int theMode)
	Compute ambient light source presentation as a sphere at view corner.

virtual void	computeDirectional (const occ::handle< Prs3d_Presentation > &thePrs, const int theMode)
	Compute directional light source presentation as a set of arrows at view corner.

virtual void	computePositional (const occ::handle< Prs3d_Presentation > &thePrs, const int theMode)
	Compute positional light source presentation as a sphere of either fixed size (no range) or of size representing a maximum range.

virtual void	computeSpot (const occ::handle< Prs3d_Presentation > &thePrs, const int theMode)
	Compute spot light source presentation as a cone.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Member Functions inherited from AIS_InteractiveObject
	AIS_InteractiveObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
	The TypeOfPresention3d means that the interactive object may have a presentation dependent on the view of Display.

void	SetDisplayStatus (PrsMgr_DisplayStatus theStatus)
	Set presentation display status.

Protected Member Functions inherited from SelectMgr_SelectableObject
	SelectMgr_SelectableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
	Protected empty constructor.

void	setGlobalSelMode (const int theMode)
	Override global selection mode.

void	UpdateClipping () override
	Update clipping planes state.

virtual void	updateSelection (const int theMode)
	Sets update status FULL to selections of the object. Must be used as the only method of UpdateSelection from outer classes to prevent BVH structures from being outdated.

Protected Member Functions inherited from PrsMgr_PresentableObject
called instead void	Update (bool theToIncludeHidden=false)
	Recomputes all presentations of the object.

This method is deprecated	SetToUpdate ()+UpdatePresentations() should be called instead") 1 void Update(int theMode
	Recomputes the presentation in the given mode.

	PrsMgr_PresentableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
	Destructor.

	~PrsMgr_PresentableObject () override
	Destructor.

virtual void	Fill (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const occ::handle< PrsMgr_Presentation > &thePrs, const int theMode)
	Fills the given 3D view presentation for specified display mode using Compute() method. In addition, configures other properties of presentation (transformation, clipping planes).

virtual void	computeHLR (const occ::handle< Graphic3d_Camera > &theProjector, const occ::handle< TopLoc_Datum3D > &theTrsf, const occ::handle< Prs3d_Presentation > &thePrs)
	Calculates hidden line removal presentation for specific camera position. Each of the views in the viewer and every modification such as rotation, for example, entails recalculation. Default implementation throws Standard_NotImplemented exception Warning! The transformation must be applied to the object before computation.

bool	UpdatePresentations (bool theToIncludeHidden=false)
	Recomputes invalidated presentations of the object.

virtual void	SetCombinedParentTransform (const occ::handle< TopLoc_Datum3D > &theTrsf)
	Sets myCombinedParentTransform to theTransformation. Thus object receives transformation from parent node and able to derive its own.

void	recomputeComputed () const
	Recompute computed (HLR) presentations (when view is in computed mode).

void	replaceAspects (const NCollection_DataMap< occ::handle< Graphic3d_Aspects >, occ::handle< Graphic3d_Aspects > > &theMap)
	Replace aspects of existing (computed) presentation groups, so that the new aspects can be applied without recomputing presentation. It is NOT recommended approach, because user has to fill such map and then search for each occurrence in computed groups. The recommended approach is computing presentation with necessary customized aspects, and then modify them directly followed by SynchronizeAspects() call.

Static Protected Member Functions inherited from PrsMgr_PresentableObject
static const gp_Trsf &	getIdentityTrsf ()
	Return the identity transformation.

Protected Attributes inherited from AIS_InteractiveObject
AIS_InteractiveContext *	myCTXPtr
	pointer to Interactive Context, where object is currently displayed;

occ::handle< Standard_Transient >	myOwner
	application-specific owner object

Protected Attributes inherited from SelectMgr_SelectableObject
NCollection_Sequence< occ::handle< SelectMgr_Selection > >	myselections
	list of selections

occ::handle< Prs3d_Presentation >	mySelectionPrs
	optional presentation for highlighting selected object

occ::handle< Prs3d_Presentation >	myHilightPrs
	optional presentation for highlighting detected object

int	myGlobalSelMode
	global selection mode

bool	myAutoHilight
	auto-highlighting flag defining

Protected Attributes inherited from PrsMgr_PresentableObject
This method is deprecated bool	theToClearOther
	pointer to the parent object

PrsMgr_PresentableObject *	myParent
	pointer to the parent object

NCollection_Sequence< occ::handle< PrsMgr_Presentation > >	myPresentations
	list of presentations

occ::handle< Graphic3d_ViewAffinity >	myViewAffinity
	view affinity mask

occ::handle< Graphic3d_SequenceOfHClipPlane >	myClipPlanes
	sequence of object-specific clipping planes

occ::handle< Prs3d_Drawer >	myDrawer
	main presentation attributes

occ::handle< Prs3d_Drawer >	myHilightDrawer
	(optional) custom presentation attributes for highlighting selected object

occ::handle< Prs3d_Drawer >	myDynHilightDrawer
	(optional) custom presentation attributes for highlighting detected object

occ::handle< Graphic3d_TransformPers >	myTransformPersistence
	transformation persistence

occ::handle< TopLoc_Datum3D >	myLocalTransformation
	local transformation relative to parent object

occ::handle< TopLoc_Datum3D >	myTransformation
	absolute transformation of this object (combined parents + local transformations)

occ::handle< TopLoc_Datum3D >	myCombinedParentTransform
	transformation of parent object (combined for all parents)

NCollection_List< occ::handle< PrsMgr_PresentableObject > >	myChildren
	list of children

gp_GTrsf	myInvTransformation
	inversion of absolute transformation (combined parents + local transformations)

PrsMgr_TypeOfPresentation3d	myTypeOfPresentation3d
	presentation type

PrsMgr_DisplayStatus	myDisplayStatus
	presentation display status

Aspect_TypeOfFacingModel	myCurrentFacingModel
	current facing model

float	myOwnWidth
	custom width value

bool	hasOwnColor
	own color flag

bool	hasOwnMaterial
	own material flag

bool	myInfiniteState
	infinite flag

bool	myIsMutable
	mutable flag

bool	myHasOwnPresentations
	flag indicating if object should have own presentations

bool	myToPropagateVisualState
	flag indicating if visual state (display/erase/color) should be propagated to all children

Detailed Description

Interactive object for a light source. Each type of light source has it's own presentation:

Ambient light is displayed as a sphere at view corner;
Positional light is represented by a sphere or marker;
Spot light is represented by a cone;
Directional light is represented by a set of arrows at the corner of view. In addition, light source name could be displayed, and clicking on presentation will enable/disable light.

Constructor & Destructor Documentation

◆ AIS_LightSource()

AIS_LightSource::AIS_LightSource ( const occ::handle< Graphic3d_CLight > & theLightSource )

Initializes the light source by copying Graphic3d_CLight settings.

Member Function Documentation

◆ AcceptDisplayMode()

bool AIS_LightSource::AcceptDisplayMode ( const int theMode ) const

inlineoverrideprotectedvirtual

Return true if specified display mode is supported: 0 for main presentation and 1 for highlight.

Reimplemented from PrsMgr_PresentableObject.

◆ ArcSize()

int AIS_LightSource::ArcSize ( ) const

inline

Returns Sensitive sphere arc size in pixels; 20 by default.

◆ Compute()

void AIS_LightSource::Compute	(	const occ::handle< PrsMgr_PresentationManager > &	thePrsMgr,
		const occ::handle< Prs3d_Presentation > &	thePrs,
		const int	theMode )

overrideprotectedvirtual

Computes selection sensitive zones(triangulation) for light source presentation.

Implements PrsMgr_PresentableObject.

◆ computeAmbient()

virtual void AIS_LightSource::computeAmbient	(	const occ::handle< Prs3d_Presentation > &	thePrs,
		const int	theMode )

protectedvirtual

Compute ambient light source presentation as a sphere at view corner.

◆ computeDirectional()

virtual void AIS_LightSource::computeDirectional	(	const occ::handle< Prs3d_Presentation > &	thePrs,
		const int	theMode )

protectedvirtual

Compute directional light source presentation as a set of arrows at view corner.

◆ computePositional()

virtual void AIS_LightSource::computePositional	(	const occ::handle< Prs3d_Presentation > &	thePrs,
		const int	theMode )

protectedvirtual

Compute positional light source presentation as a sphere of either fixed size (no range) or of size representing a maximum range.

◆ ComputeSelection()

void AIS_LightSource::ComputeSelection	(	const occ::handle< SelectMgr_Selection > &	theSel,
		const int	theMode )

overrideprotectedvirtual

Fills presentation.

Implements SelectMgr_SelectableObject.

◆ computeSpot()

virtual void AIS_LightSource::computeSpot	(	const occ::handle< Prs3d_Presentation > &	thePrs,
		const int	theMode )

protectedvirtual

Compute spot light source presentation as a cone.

◆ IsZoomable()

bool AIS_LightSource::IsZoomable ( ) const

inline

Returns TRUE if transform-persistence is allowed; TRUE by default for Ambient and Directional lights and FALSE by default for Positional and Spot lights.

◆ Light()

const occ::handle< Graphic3d_CLight > & AIS_LightSource::Light ( ) const

inline

Returns the light.

◆ MarkerImage()

const occ::handle< Graphic3d_MarkerImage > & AIS_LightSource::MarkerImage ( bool theIsEnabled ) const

inline

Returns light source icon.

Parameters

[in] theIsEnabled marker index for enabled/disabled light source states

◆ MarkerType()

Aspect_TypeOfMarker AIS_LightSource::MarkerType ( bool theIsEnabled ) const

inline

Returns light source icon.

Parameters

[in] theIsEnabled marker index for enabled/disabled light source states

◆ NbArrows()

int AIS_LightSource::NbArrows ( ) const

inline

Returns a number of directional light arrows to display; 5 by default.

◆ NbSplitsArrow()

int AIS_LightSource::NbSplitsArrow ( ) const

inline

Returns tessellation level for arrows; 20 by default.

◆ NbSplitsQuadric()

int AIS_LightSource::NbSplitsQuadric ( ) const

inline

Returns tessellation level for quadric surfaces; 30 by default.

◆ ProcessDragging()

bool AIS_LightSource::ProcessDragging	(	const occ::handle< AIS_InteractiveContext > &	theCtx,
		const occ::handle< V3d_View > &	theView,
		const occ::handle< SelectMgr_EntityOwner > &	theOwner,
		const NCollection_Vec2< int > &	theDragFrom,
		const NCollection_Vec2< int > &	theDragTo,
		const AIS_DragAction	theAction )

overrideprotectedvirtual

Drag object in the viewer.

Parameters

[in]	theCtx	interactive context
[in]	theView	active View
[in]	theOwner	the owner of detected entity
[in]	theDragFrom	drag start point
[in]	theDragTo	drag end point
[in]	theAction	drag action

Returns: FALSE if object rejects dragging action (e.g. AIS_DragAction_Start)

Reimplemented from AIS_InteractiveObject.

◆ SetArcSize()

void AIS_LightSource::SetArcSize ( int theSize )

inline

Sets the size of sensitive sphere arc.

◆ SetDisplayName()

void AIS_LightSource::SetDisplayName ( bool theToDisplay )

inline

Show/hide light source name.

◆ SetDisplayRange()

void AIS_LightSource::SetDisplayRange ( bool theToDisplay )

inline

Show/hide light source range shaded presentation.

◆ SetDraggable()

void AIS_LightSource::SetDraggable ( bool theIsDraggable )

inline

Sets if dragging is allowed.

◆ SetLight()

void AIS_LightSource::SetLight ( const occ::handle< Graphic3d_CLight > & theLight )

inline

Set the light.

◆ setLocalTransformation()

void AIS_LightSource::setLocalTransformation ( const occ::handle< TopLoc_Datum3D > & theTrsf )

overrideprotectedvirtual

Sets new local transformation, which is propagated to Graphic3d_CLight instance.

Reimplemented from PrsMgr_PresentableObject.

◆ SetMarkerImage()

void AIS_LightSource::SetMarkerImage	(	const occ::handle< Graphic3d_MarkerImage > &	theImage,
		bool	theIsEnabled )

inline

Sets custom icon to light source.

◆ SetMarkerType()

void AIS_LightSource::SetMarkerType	(	Aspect_TypeOfMarker	theType,
		bool	theIsEnabled )

inline

Sets standard icon to light source.

◆ SetNbArrows()

void AIS_LightSource::SetNbArrows ( int theNbArrows )

inline

Returns a number of directional light arrows to display (supported values: 1, 3, 5, 9).

◆ SetNbSplitsArrow()

void AIS_LightSource::SetNbSplitsArrow ( int theNbSplits )

inline

Sets tessellation level for arrows.

◆ SetNbSplitsQuadric()

void AIS_LightSource::SetNbSplitsQuadric ( int theNbSplits )

inline

Sets tessellation level for quadric surfaces.

◆ SetSize()

void AIS_LightSource::SetSize ( double theSize )

inline

Sets the size of presentation.

◆ SetSwitchOnClick()

void AIS_LightSource::SetSwitchOnClick ( bool theToHandle )

inline

Sets if mouse click should turn light on/off.

◆ SetZoomable()

void AIS_LightSource::SetZoomable ( bool theIsZoomable )

inline

Sets if transform-persistence is allowed.

◆ Size()

double AIS_LightSource::Size ( ) const

inline

Returns the size of presentation; 50 by default.

◆ ToDisplayName()

bool AIS_LightSource::ToDisplayName ( ) const

inline

displayed light source

◆ ToDisplayRange()

bool AIS_LightSource::ToDisplayRange ( ) const

inline

Returns TRUE to display light source range as sphere (positional light) or cone (spot light); TRUE by default. Has no effect for non-zoomable presentation.

◆ ToSwitchOnClick()

bool AIS_LightSource::ToSwitchOnClick ( ) const

inline

Returns TRUE if mouse click will turn light on/off; TRUE by default.

◆ Type()

AIS_KindOfInteractive AIS_LightSource::Type ( ) const

inlineoverridevirtual

Returns kind of the object.

Reimplemented from AIS_InteractiveObject.

◆ updateLightAspects()

virtual void AIS_LightSource::updateLightAspects ( )

protectedvirtual

Sets color of light.

◆ updateLightLocalTransformation()

virtual void AIS_LightSource::updateLightLocalTransformation ( )

protectedvirtual

Updates local transformation basing on a type of light source.

◆ updateLightTransformPersistence()

virtual void AIS_LightSource::updateLightTransformPersistence ( )

protectedvirtual

Updates transform persistence basing on a type of light source.

Field Documentation

◆ myArrowLineAspectShadow

occ::handle<Graphic3d_AspectLine3d> AIS_LightSource::myArrowLineAspectShadow

protected

arrow shadow style

◆ myCodirMarkerType

Aspect_TypeOfMarker AIS_LightSource::myCodirMarkerType

protected

icon of arrow co-directional to camera direction (look from)

◆ myDisabledMarkerAspect

occ::handle<Graphic3d_AspectMarker3d> AIS_LightSource::myDisabledMarkerAspect

protected

disabled light source marker style

◆ myIsDraggable

bool AIS_LightSource::myIsDraggable

protected

flag to allow/disallow rotate directional light source by dragging

◆ myIsZoomable

bool AIS_LightSource::myIsZoomable

protected

sensitive sphere arc size in pixels

flag to allow/disallow transform-persistence when possible

◆ myLightSource

occ::handle<Graphic3d_CLight> AIS_LightSource::myLightSource

protected

displayed light source

◆ myLocTrsfStart

gp_Trsf AIS_LightSource::myLocTrsfStart

protected

object transformation before transformation

◆ myMarkerImages

occ::handle<Graphic3d_MarkerImage> AIS_LightSource::myMarkerImages[2]

protected

icon of disabled (0) and enabled (1) light

◆ myMarkerTypes

Aspect_TypeOfMarker AIS_LightSource::myMarkerTypes[2]

protected

icon of disabled (0) and enabled (1) light

◆ myNbArrows

int AIS_LightSource::myNbArrows

protected

number of directional light arrows

◆ myNbSplitsArrow

int AIS_LightSource::myNbSplitsArrow

protected

tessellation level for arrows

◆ myNbSplitsQuadric

int AIS_LightSource::myNbSplitsQuadric

protected

tessellation level for quadric surfaces

◆ myOpposMarkerType

Aspect_TypeOfMarker AIS_LightSource::myOpposMarkerType

protected

icon of arrow opposite to camera direction (look at)

◆ mySensSphere

occ::handle<Select3D_SensitiveSphere> AIS_LightSource::mySensSphere

protected

sensitive sphere of directional light source

◆ mySensSphereArcSize

int AIS_LightSource::mySensSphereArcSize

protected

displayed light source

◆ mySize

double AIS_LightSource::mySize

protected

presentation size

◆ myToDisplayName

bool AIS_LightSource::myToDisplayName

protected

flag to show/hide name

◆ myToDisplayRange

bool AIS_LightSource::myToDisplayRange

protected

flag to show/hide range of positional/spot light

◆ myToSwitchOnClick

bool AIS_LightSource::myToSwitchOnClick

protected

flag to handle mouse click to turn light on/off

The documentation for this class was generated from the following file:

AIS_LightSource.hxx

Public Member Functions

Light properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AIS_LightSource()

Member Function Documentation

◆ AcceptDisplayMode()

◆ ArcSize()

◆ Compute()

◆ computeAmbient()

◆ computeDirectional()

◆ computePositional()

◆ ComputeSelection()

◆ computeSpot()

◆ IsZoomable()

◆ Light()

◆ MarkerImage()

◆ MarkerType()

◆ NbArrows()

◆ NbSplitsArrow()

◆ NbSplitsQuadric()

◆ ProcessDragging()

◆ SetArcSize()

◆ SetDisplayName()

◆ SetDisplayRange()

◆ SetDraggable()

◆ SetLight()

◆ setLocalTransformation()

◆ SetMarkerImage()

◆ SetMarkerType()

◆ SetNbArrows()

◆ SetNbSplitsArrow()

◆ SetNbSplitsQuadric()

◆ SetSize()

◆ SetSwitchOnClick()

◆ SetZoomable()

◆ Size()

◆ ToDisplayName()

◆ ToDisplayRange()

◆ ToSwitchOnClick()

◆ Type()

◆ updateLightAspects()

◆ updateLightLocalTransformation()

◆ updateLightTransformPersistence()

Field Documentation

◆ myArrowLineAspectShadow

◆ myCodirMarkerType

◆ myDisabledMarkerAspect

◆ myIsDraggable

◆ myIsZoomable

◆ myLightSource

◆ myLocTrsfStart

◆ myMarkerImages

◆ myMarkerTypes

◆ myNbArrows

◆ myNbSplitsArrow

◆ myNbSplitsQuadric

◆ myOpposMarkerType

◆ mySensSphere

◆ mySensSphereArcSize

◆ mySize

◆ myToDisplayName

◆ myToDisplayRange

◆ myToSwitchOnClick