v_sim.GlExtSet¶
- Subclasses:
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
|
|
|
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w |
background alpha channel |
||
r/w |
background blue channel |
||
r/w |
background green channel |
||
r/w |
background red channel |
||
r |
one of the object rendering is out of date |
||
r/w |
Fog is used |
||
r/w |
specific fog alpha channel |
||
r/w |
specific fog blue channel |
||
r/w |
Fog color is the bg color |
||
r/w |
depth where fog hides all |
||
r/w |
specific fog green channel |
||
r/w |
specific fog red channel |
||
r/w |
starting fog depth |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
|---|---|---|---|
parent |
r |
||
priv |
r |
Class Details¶
- class v_sim.GlExtSet(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
Common name to refer to a #_VisuGlExtSet.
- classmethod new()¶
- Returns:
a newly created
v_sim.GlExtSetobject.- Return type:
Create an object to handle a set of
v_sim.GlExtobjects and draw them together.New in version 3.8.
- add(ext)¶
- Parameters:
ext (
v_sim.GlExt) – av_sim.GlExtobject.- Returns:
Trueif not already existing.- Return type:
Add ext in the list of drawn
v_sim.GlExtby self.New in version 3.8.
- draw()¶
Basic drawing method : it clears the OpenGL area and call all lists stored in self.
New in version 3.8.
- getAll()¶
- Returns:
only the container list should be freed after.
- Return type:
Retrieve as a
GLib.Listall thev_sim.GlExtobjects drawn by self.New in version 3.8.
- getBgColor()¶
- Returns:
a storage for four values.
- Return type:
rgba: [
float]
Read the RGBA value of the specific background colour (in [0;1]).
New in version 3.8.
- getByName(name)¶
- Parameters:
name (
str) – a name to look for.- Returns:
a
v_sim.GlExtwith name.- Return type:
Retrieve the
v_sim.GlExtobject with name that is stored in self. If severalv_sim.GlExtobjects have the same name, the first one is returned.New in version 3.8.
- getFogActive()¶
-
Read if fog is used or not.
New in version 3.8.
- getFogColor()¶
- Returns:
a storage for three values.
- Return type:
rgba: [
float]
Gives the actual fog color, for the specific color, use
v_sim.GlExtSet.getFogSpecificColor().New in version 3.8.
- getFogFollowsBg()¶
- Returns:
Trueif the fog uses its own color orFalseif it uses the color of the background.- Return type:
Read if fog uses a specific colour or not.
New in version 3.8.
- getFogSpecificColor()¶
- Returns:
a storage for three values.
- Return type:
rgba: [
float]
Gives the specific fog color, for the actual color, use
v_sim.GlExtSet.getFogColor().New in version 3.8.
- getFogStartFull()¶
- Returns:
two float location.
- Return type:
startFull: [
float]
Retrieves the starting and ending value (reduced) of fog extension.
New in version 3.8.
- getPixmapData(width, height, hasAlpha)¶
- Parameters:
- Returns:
image data, row by row.
- Return type:
[
int]
Create an image from the OpenGL area. The size can be changed, using width and height. If these pointers contains positive values, then they are used to set the size for the image. If not, the size of the current
v_sim.GlViewis used and stored in these pointers.New in version 3.8.
- remove(ext)¶
- Parameters:
ext (
v_sim.GlExt) – av_sim.GlExtobject.- Returns:
Trueif successfully removed.- Return type:
Remove ext in the list of drawn
v_sim.GlExtby self.New in version 3.8.
- setBgColor(rgba, mask)¶
- Parameters:
rgba ([
float]) – a three floats array with values (0 <= values <= 1) for the red, the green and the blue color. Only values specified by the mask are really relevant.mask (
int) – usev_sim.COLOR_MASK_R,v_sim.COLOR_MASK_G,v_sim.COLOR_MASK_B,v_sim.COLOR_MASK_RGBAor a combinaison to indicate what values in the rgb array must be taken into account.
- Returns:
Trueif changed.- Return type:
Method used to change the value of the parameter background_color.
New in version 3.8.
- setFogActive(value)¶
-
Activates the fog rendering, or not.
New in version 3.8.
- setFogColor(rgba, mask)¶
- Parameters:
rgba ([
float]) – four [0;1] float values.mask (
int) – a mask, seev_sim.COLOR_MASK_Rfor instance.
- Returns:
Trueif value is actually changed.- Return type:
Change the fog specific colour. Activate it with
v_sim.GlExtSet.setFogFollowsBg().New in version 3.8.
- setFogFollowsBg(value)¶
-
Specifies if the fog is coloured with the background colour or with its own colour, see
v_sim.GlExtSet.setFogColor().New in version 3.8.
- setFogStartFull(startEnd, mask)¶
- Parameters:
startEnd ([
float]) – two [0;1] floating point values.mask (
int) – a mask, seev_sim.GL_EXT_SET_FOG_MASK_STARTandv_sim.GL_EXT_SET_FOG_MASK_FULL.
- Returns:
Trueif values are actually changed.- Return type:
Change the starting and ending point of fog.
New in version 3.8.
- setGlView(view)¶
- Parameters:
view (
v_sim.GlView) – av_sim.GlViewobject.- Returns:
Trueif the view actually change.- Return type:
Apply the given view on all
v_sim.GlExtobjects stored in self.New in version 3.8.
- do_added(ext) virtual¶
- Parameters:
ext (
v_sim.GlExt) –
executed when ext is added.
- do_removed(ext) virtual¶
- Parameters:
ext (
v_sim.GlExt) –
executed when ext is removed.
Property Details¶
- v_sim.GlExtSet.props.bg_alpha¶
-
background alpha channel
- v_sim.GlExtSet.props.bg_blue¶
-
background blue channel
- v_sim.GlExtSet.props.bg_green¶
-
background green channel
- v_sim.GlExtSet.props.bg_red¶
-
background red channel
- v_sim.GlExtSet.props.dirty¶
-
one of the object rendering is out of date
- v_sim.GlExtSet.props.fog_active¶
-
Fog is used
- v_sim.GlExtSet.props.fog_alpha¶
-
specific fog alpha channel
- v_sim.GlExtSet.props.fog_blue¶
-
specific fog blue channel
- v_sim.GlExtSet.props.fog_follows_bg¶
-
Fog color is the bg color
- v_sim.GlExtSet.props.fog_full¶
-
depth where fog hides all
- v_sim.GlExtSet.props.fog_green¶
-
specific fog green channel
- v_sim.GlExtSet.props.fog_red¶
-
specific fog red channel