rfm2.vp.geo.ramp.Ramp Class Reference

Inheritance diagram for rfm2.vp.geo.ramp.Ramp:

Collaboration diagram for rfm2.vp.geo.ramp.Ramp:

Public Member Functions
def	__init__ (self, jsondict)
def	is_static (self)
def	opacity (self)
def	vtx_buffer_count (self)
def	vtx_buffer (self)
def	color_buffer (self)
def	idx_buffer (self, idx_buffer, num_vtx, start_idx, inst_idx)
def	set_input_params (self, obj, **kwargs)
Public Member Functions inherited from rfm2.vp.geo.base.Vp2GeometryBase
def	defaulted_value (self, name, default_val)
def	instance_draw_method (self, instance_idx)
def	instance_display_mode (self, instance_idx)
def	instance_vp2_primitive (self, instance_idx)
def	instance_enabled (self, instance_idx)
def	get_input_params (self)
def	vtx_buffer (self, **kwargs)
def	has_uvs (self)
def	uv_buffer (self)

Public Attributes
	subdivs
	disk
	rect
	mode
	begin_dist
	end_dist
	color
	ramp_data
Public Attributes inherited from rfm2.vp.geo.base.Vp2GeometryBase
	id
	textured
	num_instances
	inst_display_mode
	inst_draw_method
	inst_index_buffer
	inst_vp_shader
	method
	kwargs
	is_deforming_when_transformed

Constructor & Destructor Documentation

__init__()

def rfm2.vp.geo.ramp.Ramp.__init__	(		self,
			jsondict
	)

Reimplemented from rfm2.vp.geo.base.Vp2GeometryBase.

Member Function Documentation

color_buffer()

def rfm2.vp.geo.ramp.Ramp.color_buffer

(

self

)

Return per-vertex color data as a list of lists. It should be
ordered exactly like the vertex buffer points and have the same size
as the vxt buffer.
The default implementation returns a zero-filled list the same size
as the vtx buffer to keep the uv buffer aligned with the vtx buffer.
NOTE: colors have FOUR components: R, G, B, A.

Reimplemented from rfm2.vp.geo.base.Vp2GeometryBase.

Here is the call graph for this function:

idx_buffer()

def rfm2.vp.geo.ramp.Ramp.idx_buffer	(		self,
			idx_buffer,
			num_vtx,
			start_idx,
			inst_idx
	)

Fill the provided index buffer to draw the shape.
NOTE: This index buffer must be valid for all vertex buffers,
i.e. positions and uvs.

Reimplemented from rfm2.vp.geo.base.Vp2GeometryBase.

Here is the call graph for this function:

is_static()

def rfm2.vp.geo.ramp.Ramp.is_static

(

self

)

Tells the vp code if the geometry is static or deforming, like a spot
light frustum for example. Defaults to True.

Reimplemented from rfm2.vp.geo.base.Vp2GeometryBase.

opacity()

def rfm2.vp.geo.ramp.Ramp.opacity

(

self

)

Returns the opacity for that shape.

Reimplemented from rfm2.vp.geo.base.Vp2GeometryBase.

Here is the caller graph for this function:

set_input_params()

def rfm2.vp.geo.ramp.Ramp.set_input_params	(		self,
			obj,
		**	kwargs
	)

Update internal input param values using kwargs.

Reimplemented from rfm2.vp.geo.base.Vp2GeometryBase.

vtx_buffer()

def rfm2.vp.geo.ramp.Ramp.vtx_buffer

(

self

)

Return a list of vertices (list) in local space.

vtx_buffer_count()

def rfm2.vp.geo.ramp.Ramp.vtx_buffer_count

(

self

)

Return the number of vertices in this buffer.

Reimplemented from rfm2.vp.geo.base.Vp2GeometryBase.

Here is the caller graph for this function:

Member Data Documentation

begin_dist

rfm2.vp.geo.ramp.Ramp.begin_dist

color

rfm2.vp.geo.ramp.Ramp.color

disk

rfm2.vp.geo.ramp.Ramp.disk

end_dist

rfm2.vp.geo.ramp.Ramp.end_dist

mode

rfm2.vp.geo.ramp.Ramp.mode

ramp_data

rfm2.vp.geo.ramp.Ramp.ramp_data

rect

rfm2.vp.geo.ramp.Ramp.rect

subdivs

rfm2.vp.geo.ramp.Ramp.subdivs

---

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

• /Users/plp/Perforce/plp_thebridge_rman_24_dev/rat/apps/rfm/scripts/rfm2/vp/geo/ramp.py