Light

Inheritance: java.lang.Object, com.aspose.threed.A3DObject, com.aspose.threed.SceneObject, com.aspose.threed.Entity, com.aspose.threed.Frustum

public class Light extends Frustum

The light illuminates the scene.

The formula to calculate the total attenuation of light is: A = ConstantAttenuation + (Dist * LinearAttenuation) + ((Dist^2) * QuadraticAttenuation)

Constructors

Constructor	Description
Light()	Initializes a new instance of the Light class.
Light(String name)	Initializes a new instance of the Light class.
Light(String name, LightType type)	Initializes a new instance of the Light class.

Methods

Method	Description
equals(Object arg0)
findProperty(String propertyName)	Finds the property.
getAspect()	Gets the aspect ratio of the frustum
getBoundingBox()	Gets the bounding box of current entity in its object space coordinate system.
getCastLight()	Gets if the current light instance can illuminate other objects.
getCastShadows()	Gets if the light can cast shadows on other objects.
getClass()
getColor()	Gets the light’s color
getConstantAttenuation()	Gets the constant attenuation to calculate the total attenuation of the light
getDirection()	Gets the direction that the camera is looking at.
getEntityRendererKey()	Gets the key of the entity renderer registered in the renderer
getExcluded()	Gets whether to exclude this entity during exporting.
getFalloff()	Gets the falloff cone angle (in degrees).
getFarPlane()	Gets the frustum’s far plane distance.
getHotSpot()	Gets the hot spot cone angle(in degrees).
getIntensity()	Gets the light’s intensity, default value is 100
getLightType()	Gets the light’s type
getLinearAttenuation()	Gets the linear attenuation to calculate the total attenuation of the light
getLookAt()	Gets the the interested position that the camera is looking at.
getName()	Gets the name.
getNearPlane()	Gets the frustum’s near plane distance.
getOrthoHeight()	Gets the height when frustum in orthographic projection.
getParentNode()	Gets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.
getParentNodes()	Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing
getProperties()	Gets the collection of all properties.
getProperty(String property)	Get the value of specified property
getQuadraticAttenuation()	Gets the quadratic attenuation to calculate the total attenuation of the light
getRotationMode()	Gets the frustum’s orientation mode This property only works when the getTarget is null.
getScene()	Gets the scene that this object belongs to
getShadowColor()	Gets the shadow’s color.
getTarget()	Gets the target that the camera is looking at.
getUp()	Gets the up direction of the camera
hashCode()
notify()
notifyAll()
removeProperty(Property property)	Removes a dynamic property.
removeProperty(String property)	Remove the specified property identified by name
setAspect(double value)	Sets the aspect ratio of the frustum
setCastLight(boolean value)	Sets if the current light instance can illuminate other objects.
setCastShadows(boolean value)	Sets if the light can cast shadows on other objects.
setColor(Vector3 value)	Sets the light’s color
setConstantAttenuation(double value)	Sets the constant attenuation to calculate the total attenuation of the light
setDirection(Vector3 value)	Sets the direction that the camera is looking at.
setExcluded(boolean value)	Sets whether to exclude this entity during exporting.
setFalloff(double value)	Sets the falloff cone angle (in degrees).
setFarPlane(double value)	Sets the frustum’s far plane distance.
setHotSpot(double value)	Sets the hot spot cone angle(in degrees).
setIntensity(double value)	Sets the light’s intensity, default value is 100
setLightType(LightType value)	Sets the light’s type
setLinearAttenuation(double value)	Sets the linear attenuation to calculate the total attenuation of the light
setLookAt(Vector3 value)	Sets the the interested position that the camera is looking at.
setName(String value)	Sets the name.
setNearPlane(double value)	Sets the frustum’s near plane distance.
setOrthoHeight(double value)	Sets the height when frustum in orthographic projection.
setParentNode(Node value)	Sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.
setProperty(String property, Object value)	Sets the value of specified property
setQuadraticAttenuation(double value)	Sets the quadratic attenuation to calculate the total attenuation of the light
setRotationMode(RotationMode value)	Sets the frustum’s orientation mode This property only works when the getTarget is null.
setShadowColor(Vector3 value)	Sets the shadow’s color.
setTarget(Node value)	Sets the target that the camera is looking at.
setUp(Vector3 value)	Sets the up direction of the camera
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

Light()

public Light()

Initializes a new instance of the Light class.

Light(String name)

public Light(String name)

Initializes a new instance of the Light class.

Parameters:

Parameter	Type	Description
name	java.lang.String	Name

Light(String name, LightType type)

public Light(String name, LightType type)

Initializes a new instance of the Light class.

Parameters:

Parameter	Type	Description
name	java.lang.String	Name
type	LightType	New light’s type

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

findProperty(String propertyName)

public Property findProperty(String propertyName)

Finds the property. It can be a dynamic property (Created by CreateDynamicProperty/SetProperty) or native property(Identified by its name)

Parameters:

Parameter	Type	Description
propertyName	java.lang.String	Property name.

Returns: Property - The property.

getAspect()

public double getAspect()

Gets the aspect ratio of the frustum

Returns: double - the aspect ratio of the frustum

getBoundingBox()

public BoundingBox getBoundingBox()

Gets the bounding box of current entity in its object space coordinate system.

Returns: BoundingBox - the bounding box of current entity in its object space coordinate system. Example: The following code shows how to calculate the bounding box of a shape

Entity entity = new Sphere();
     entity.setRadius(10);
     var bbox = entity.getBoundingBox();
     System.out.printf("The bounding box of the entity is %s ~ %s", bbox.getMinimum(), bbox.getMaximum());

getCastLight()

public boolean getCastLight()

Gets if the current light instance can illuminate other objects.

Returns: boolean - if the current light instance can illuminate other objects.

getCastShadows()

public boolean getCastShadows()

Gets if the light can cast shadows on other objects.

Returns: boolean - if the light can cast shadows on other objects.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getColor()

public Vector3 getColor()

Gets the light’s color

Returns: Vector3 - the light’s color

getConstantAttenuation()

public double getConstantAttenuation()

Gets the constant attenuation to calculate the total attenuation of the light

Returns: double - the constant attenuation to calculate the total attenuation of the light

getDirection()

public Vector3 getDirection()

Gets the direction that the camera is looking at. Changes on this property will also affects the getLookAt and getTarget.

Returns: Vector3 - the direction that the camera is looking at. Changes on this property will also affects the getLookAt and getTarget.

getEntityRendererKey()

public EntityRendererKey getEntityRendererKey()

Gets the key of the entity renderer registered in the renderer

Returns: EntityRendererKey - the key of the entity renderer registered in the renderer

getExcluded()

public boolean getExcluded()

Gets whether to exclude this entity during exporting.

Returns: boolean - whether to exclude this entity during exporting.

getFalloff()

public double getFalloff()

Gets the falloff cone angle (in degrees).

Returns: double - the falloff cone angle (in degrees).

getFarPlane()

public double getFarPlane()

Gets the frustum’s far plane distance.

Returns: double - the frustum’s far plane distance.

getHotSpot()

public double getHotSpot()

Gets the hot spot cone angle(in degrees).

Returns: double - the hot spot cone angle(in degrees).

getIntensity()

public double getIntensity()

Gets the light’s intensity, default value is 100

Returns: double - the light’s intensity, default value is 100

getLightType()

public LightType getLightType()

Gets the light’s type

Returns: LightType - the light’s type

getLinearAttenuation()

public double getLinearAttenuation()

Gets the linear attenuation to calculate the total attenuation of the light

Returns: double - the linear attenuation to calculate the total attenuation of the light

getLookAt()

public Vector3 getLookAt()

Gets the the interested position that the camera is looking at.

Returns: Vector3 - the the interested position that the camera is looking at.

getName()

public String getName()

Gets the name.

Returns: java.lang.String - the name.

getNearPlane()

public double getNearPlane()

Gets the frustum’s near plane distance.

Returns: double - the frustum’s near plane distance.

getOrthoHeight()

public double getOrthoHeight()

Gets the height when frustum in orthographic projection.

Returns: double - the height when frustum in orthographic projection.

getParentNode()

public Node getParentNode()

Gets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.

Returns: Node - the first parent node, if set the first parent node, this entity will be detached from other parent nodes.

getParentNodes()

public ArrayList<Node> getParentNodes()

Gets all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing

Returns: java.util.ArrayList<com.aspose.threed.Node> - all parent nodes, an entity can be attached to multiple parent nodes for geometry instancing

getProperties()

public PropertyCollection getProperties()

Gets the collection of all properties.

Returns: PropertyCollection - the collection of all properties.

getProperty(String property)

public Object getProperty(String property)

Get the value of specified property

Parameters:

Parameter	Type	Description
property	java.lang.String	Property name

Returns: java.lang.Object - The value of the found property

getQuadraticAttenuation()

public double getQuadraticAttenuation()

Gets the quadratic attenuation to calculate the total attenuation of the light

Returns: double - the quadratic attenuation to calculate the total attenuation of the light

getRotationMode()

public RotationMode getRotationMode()

Gets the frustum’s orientation mode This property only works when the getTarget is null. If the value is RotationMode.FIXED_TARGET, the direction is always calculated by the property getLookAt Otherwise the getLookAt is always calculated by the getDirection

Returns: RotationMode - the frustum’s orientation mode This property only works when the getTarget is null. If the value is RotationMode.FIXED_TARGET, the direction is always calculated by the property getLookAt Otherwise the getLookAt is always calculated by the getDirection

getScene()

public Scene getScene()

Gets the scene that this object belongs to

Returns: Scene - the scene that this object belongs to

getShadowColor()

public Vector3 getShadowColor()

Gets the shadow’s color.

Returns: Vector3 - the shadow’s color.

getTarget()

public Node getTarget()

Gets the target that the camera is looking at. If the user supports this property, it should be prior to getLookAt property.

Returns: Node - the target that the camera is looking at. If the user supports this property, it should be prior to getLookAt property.

getUp()

public Vector3 getUp()

Gets the up direction of the camera

Returns: Vector3 - the up direction of the camera

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

removeProperty(Property property)

public boolean removeProperty(Property property)

Removes a dynamic property.

Parameters:

Parameter	Type	Description
property	Property	Which property to remove

Returns: boolean - true if the property is successfully removed

removeProperty(String property)

public boolean removeProperty(String property)

Remove the specified property identified by name

Parameters:

Parameter	Type	Description
property	java.lang.String	Which property to remove

Returns: boolean - true if the property is successfully removed

setAspect(double value)

public void setAspect(double value)

Sets the aspect ratio of the frustum

Parameters:

Parameter	Type	Description
value	double	New value

setCastLight(boolean value)

public void setCastLight(boolean value)

Sets if the current light instance can illuminate other objects.

Parameters:

Parameter	Type	Description
value	boolean	New value

setCastShadows(boolean value)

public void setCastShadows(boolean value)

Sets if the light can cast shadows on other objects.

Parameters:

Parameter	Type	Description
value	boolean	New value

setColor(Vector3 value)

public void setColor(Vector3 value)

Sets the light’s color

Parameters:

Parameter	Type	Description
value	Vector3	New value

setConstantAttenuation(double value)

public void setConstantAttenuation(double value)

Sets the constant attenuation to calculate the total attenuation of the light

Parameters:

Parameter	Type	Description
value	double	New value

setDirection(Vector3 value)

public void setDirection(Vector3 value)

Sets the direction that the camera is looking at. Changes on this property will also affects the getLookAt and getTarget.

Parameters:

Parameter	Type	Description
value	Vector3	New value

setExcluded(boolean value)

public void setExcluded(boolean value)

Sets whether to exclude this entity during exporting.

Parameters:

Parameter	Type	Description
value	boolean	New value

setFalloff(double value)

public void setFalloff(double value)

Sets the falloff cone angle (in degrees).

Parameters:

Parameter	Type	Description
value	double	New value

setFarPlane(double value)

public void setFarPlane(double value)

Sets the frustum’s far plane distance.

Parameters:

Parameter	Type	Description
value	double	New value

setHotSpot(double value)

public void setHotSpot(double value)

Sets the hot spot cone angle(in degrees).

Parameters:

Parameter	Type	Description
value	double	New value

setIntensity(double value)

public void setIntensity(double value)

Sets the light’s intensity, default value is 100

Parameters:

Parameter	Type	Description
value	double	New value

setLightType(LightType value)

public void setLightType(LightType value)

Sets the light’s type

Parameters:

Parameter	Type	Description
value	LightType	New value

setLinearAttenuation(double value)

public void setLinearAttenuation(double value)

Sets the linear attenuation to calculate the total attenuation of the light

Parameters:

Parameter	Type	Description
value	double	New value

setLookAt(Vector3 value)

public void setLookAt(Vector3 value)

Sets the the interested position that the camera is looking at.

Parameters:

Parameter	Type	Description
value	Vector3	New value

setName(String value)

public void setName(String value)

Sets the name.

Parameters:

Parameter	Type	Description
value	java.lang.String	New value

setNearPlane(double value)

public void setNearPlane(double value)

Sets the frustum’s near plane distance.

Parameters:

Parameter	Type	Description
value	double	New value

setOrthoHeight(double value)

public void setOrthoHeight(double value)

Sets the height when frustum in orthographic projection.

Parameters:

Parameter	Type	Description
value	double	New value

setParentNode(Node value)

public void setParentNode(Node value)

Sets the first parent node, if set the first parent node, this entity will be detached from other parent nodes.

Parameters:

Parameter	Type	Description
value	Node	New value

setProperty(String property, Object value)

public void setProperty(String property, Object value)

Sets the value of specified property

Parameters:

Parameter	Type	Description
property	java.lang.String	Property name
value	java.lang.Object	The value of the property

setQuadraticAttenuation(double value)

public void setQuadraticAttenuation(double value)

Sets the quadratic attenuation to calculate the total attenuation of the light

Parameters:

Parameter	Type	Description
value	double	New value

setRotationMode(RotationMode value)

public void setRotationMode(RotationMode value)

Sets the frustum’s orientation mode This property only works when the getTarget is null. If the value is RotationMode.FIXED_TARGET, the direction is always calculated by the property getLookAt Otherwise the getLookAt is always calculated by the getDirection

Parameters:

Parameter	Type	Description
value	RotationMode	New value

setShadowColor(Vector3 value)

public void setShadowColor(Vector3 value)

Sets the shadow’s color.

Parameters:

Parameter	Type	Description
value	Vector3	New value

setTarget(Node value)

public void setTarget(Node value)

Sets the target that the camera is looking at. If the user supports this property, it should be prior to getLookAt property.

Parameters:

Parameter	Type	Description
value	Node	New value

setUp(Vector3 value)

public void setUp(Vector3 value)

Sets the up direction of the camera

Parameters:

Parameter	Type	Description
value	Vector3	New value

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int